Dataform is a service to develop, create, document, test, and update curated tables in BigQuery. v1beta1
Package
@google-cloud/dataformConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of DataformClient.
Parameters
Name
Description
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DataformClient({fallback: true}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
dataformStub
dataformStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
iamClient
iamClient
:
IamClient
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
cancelWorkflowInvocation(request, options)
cancelWorkflowInvocation
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
|
undefined
),
{}
|
undefined
]>;
Requests cancellation of a running WorkflowInvocation.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
,
( protos.google.cloud.dataform.v1beta1.ICancelWorkflowInvocationRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workflow invocation resource's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCancelWorkflowInvocation
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
cancelWorkflowInvocation
(
request
);
console
.
log
(
response
);
}
callCancelWorkflowInvocation
();
cancelWorkflowInvocation(request, options, callback)
cancelWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.ICancelWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
cancelWorkflowInvocation(request, callback)
cancelWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICancelWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.ICancelWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
commitWorkspaceChanges(request, options)
commitWorkspaceChanges
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
|
undefined
),
{}
|
undefined
]>;
Applies a Git commit for uncommitted files in a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
,
( protos.google.cloud.dataform.v1beta1.ICommitWorkspaceChangesRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
/**
* Required. The commit's author.
*/
// const author = {}
/**
* Optional. The commit's message.
*/
// const commitMessage = 'abc123'
/**
* Optional. Full file paths to commit including filename, rooted at workspace root. If
* left empty, all files will be committed.
*/
// const paths = ['abc','def']
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCommitWorkspaceChanges
()
{
// Construct request
const
request
=
{
name
,
author
,
};
// Run request
const
response
=
await
dataformClient
.
commitWorkspaceChanges
(
request
);
console
.
log
(
response
);
}
callCommitWorkspaceChanges
();
commitWorkspaceChanges(request, options, callback)
commitWorkspaceChanges
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.ICommitWorkspaceChangesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
commitWorkspaceChanges(request, callback)
commitWorkspaceChanges
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICommitWorkspaceChangesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.ICommitWorkspaceChangesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
compilationResultPath(project, location, repository, compilationResult)
compilationResultPath
(
project
:
string
,
location
:
string
,
repository
:
string
,
compilationResult
:
string
)
:
string
;
Return a fully-qualified compilationResult resource name string.
Parameters
Name
Description
project
string
location
string
repository
string
compilationResult
string
Returns
Type
Description
string
{string} Resource name string.
createCompilationResult(request, options)
createCompilationResult
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
|
undefined
),
{}
|
undefined
]>;
Creates a new CompilationResult in a given project and location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.ICompilationResult
,
( protos.google.cloud.dataform.v1beta1.ICreateCompilationResultRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository in which to create the compilation result. Must be in the
* format `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Required. The compilation result to create.
*/
// const compilationResult = {}
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCreateCompilationResult
()
{
// Construct request
const
request
=
{
parent
,
compilationResult
,
};
// Run request
const
response
=
await
dataformClient
.
createCompilationResult
(
request
);
console
.
log
(
response
);
}
callCreateCompilationResult
();
createCompilationResult(request, options, callback)
createCompilationResult
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.ICompilationResult
, protos.google.cloud.dataform.v1beta1.ICreateCompilationResultRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createCompilationResult(request, callback)
createCompilationResult
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateCompilationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.ICompilationResult
, protos.google.cloud.dataform.v1beta1.ICreateCompilationResultRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createRepository(request, options)
createRepository
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
|
undefined
,
{}
|
undefined
]>;
Creates a new Repository in a given project and location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.ICreateRepositoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location in which to create the repository. Must be in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. The repository to create.
*/
// const repository = {}
/**
* Required. The ID to use for the repository, which will become the final component of
* the repository's resource name.
*/
// const repositoryId = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCreateRepository
()
{
// Construct request
const
request
=
{
parent
,
repository
,
repositoryId
,
};
// Run request
const
response
=
await
dataformClient
.
createRepository
(
request
);
console
.
log
(
response
);
}
callCreateRepository
();
createRepository(request, options, callback)
createRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.ICreateRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createRepository(request, callback)
createRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.ICreateRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createWorkflowInvocation(request, options)
createWorkflowInvocation
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
|
undefined
),
{}
|
undefined
]>;
Creates a new WorkflowInvocation in a given Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
,
( protos.google.cloud.dataform.v1beta1.ICreateWorkflowInvocationRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository in which to create the workflow invocation. Must be in the
* format `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Required. The workflow invocation resource to create.
*/
// const workflowInvocation = {}
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCreateWorkflowInvocation
()
{
// Construct request
const
request
=
{
parent
,
workflowInvocation
,
};
// Run request
const
response
=
await
dataformClient
.
createWorkflowInvocation
(
request
);
console
.
log
(
response
);
}
callCreateWorkflowInvocation
();
createWorkflowInvocation(request, options, callback)
createWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
, protos.google.cloud.dataform.v1beta1.ICreateWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createWorkflowInvocation(request, callback)
createWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
, protos.google.cloud.dataform.v1beta1.ICreateWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createWorkspace(request, options)
createWorkspace
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
|
undefined
,
{}
|
undefined
]>;
Creates a new Workspace in a given Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.ICreateWorkspaceRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Workspace . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository in which to create the workspace. Must be in the format
* `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Required. The workspace to create.
*/
// const workspace = {}
/**
* Required. The ID to use for the workspace, which will become the final component of
* the workspace's resource name.
*/
// const workspaceId = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callCreateWorkspace
()
{
// Construct request
const
request
=
{
parent
,
workspace
,
workspaceId
,
};
// Run request
const
response
=
await
dataformClient
.
createWorkspace
(
request
);
console
.
log
(
response
);
}
callCreateWorkspace
();
createWorkspace(request, options, callback)
createWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.ICreateWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
createWorkspace(request, callback)
createWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICreateWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.ICreateWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteRepository(request, options)
deleteRepository
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
|
undefined
,
{}
|
undefined
]>;
Deletes a single Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteRepositoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository's name.
*/
// const name = 'abc123'
/**
* If set to true, any child resources of this repository will also be
* deleted. (Otherwise, the request will only succeed if the repository has no
* child resources.)
*/
// const force = true
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callDeleteRepository
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
deleteRepository
(
request
);
console
.
log
(
response
);
}
callDeleteRepository
();
deleteRepository(request, options, callback)
deleteRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteRepository(request, callback)
deleteRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteWorkflowInvocation(request, options)
deleteWorkflowInvocation
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
|
undefined
),
{}
|
undefined
]>;
Deletes a single WorkflowInvocation.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
,
( protos.google.cloud.dataform.v1beta1.IDeleteWorkflowInvocationRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workflow invocation resource's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callDeleteWorkflowInvocation
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
deleteWorkflowInvocation
(
request
);
console
.
log
(
response
);
}
callDeleteWorkflowInvocation
();
deleteWorkflowInvocation(request, options, callback)
deleteWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteWorkflowInvocation(request, callback)
deleteWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteWorkspace(request, options)
deleteWorkspace
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
|
undefined
,
{}
|
undefined
]>;
Deletes a single Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteWorkspaceRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace resource's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callDeleteWorkspace
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
deleteWorkspace
(
request
);
console
.
log
(
response
);
}
callDeleteWorkspace
();
deleteWorkspace(request, options, callback)
deleteWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteWorkspace(request, callback)
deleteWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IDeleteWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IDeleteWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchFileDiff(request, options)
fetchFileDiff
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
|
undefined
,
{}
|
undefined
]>;
Fetches Git diff for an uncommitted file in a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IFetchFileDiffResponse
, protos.google.cloud.dataform.v1beta1.IFetchFileDiffRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FetchFileDiffResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The file's full path including filename, relative to the workspace root.
*/
// const path = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callFetchFileDiff
()
{
// Construct request
const
request
=
{
workspace
,
path
,
};
// Run request
const
response
=
await
dataformClient
.
fetchFileDiff
(
request
);
console
.
log
(
response
);
}
callFetchFileDiff
();
fetchFileDiff(request, options, callback)
fetchFileDiff
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchFileDiffResponse
, protos.google.cloud.dataform.v1beta1.IFetchFileDiffRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchFileDiff(request, callback)
fetchFileDiff
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileDiffRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchFileDiffResponse
, protos.google.cloud.dataform.v1beta1.IFetchFileDiffRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchFileGitStatuses(request, options)
fetchFileGitStatuses
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesResponse
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
|
undefined
),
{}
|
undefined
]>;
Fetches Git statuses for the files in a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesResponse
,
( protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callFetchFileGitStatuses
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
fetchFileGitStatuses
(
request
);
console
.
log
(
response
);
}
callFetchFileGitStatuses
();
fetchFileGitStatuses(request, options, callback)
fetchFileGitStatuses
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesResponse
, protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchFileGitStatuses(request, callback)
fetchFileGitStatuses
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchFileGitStatusesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesResponse
, protos.google.cloud.dataform.v1beta1.IFetchFileGitStatusesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchGitAheadBehind(request, options)
fetchGitAheadBehind
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindResponse
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
|
undefined
),
{}
|
undefined
]>;
Fetches Git ahead/behind against a remote branch.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindResponse
,
( protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FetchGitAheadBehindResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
/**
* Optional. The name of the branch in the Git remote against which this workspace
* should be compared. If left unset, the repository's default branch name
* will be used.
*/
// const remoteBranch = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callFetchGitAheadBehind
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
fetchGitAheadBehind
(
request
);
console
.
log
(
response
);
}
callFetchGitAheadBehind
();
fetchGitAheadBehind(request, options, callback)
fetchGitAheadBehind
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindResponse
, protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchGitAheadBehind(request, callback)
fetchGitAheadBehind
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchGitAheadBehindRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindResponse
, protos.google.cloud.dataform.v1beta1.IFetchGitAheadBehindRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchRemoteBranches(request, options)
fetchRemoteBranches
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesResponse
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
|
undefined
),
{}
|
undefined
]>;
Fetches a Repository's remote branches.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesResponse
,
( protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FetchRemoteBranchesResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callFetchRemoteBranches
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
fetchRemoteBranches
(
request
);
console
.
log
(
response
);
}
callFetchRemoteBranches
();
fetchRemoteBranches(request, options, callback)
fetchRemoteBranches
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesResponse
, protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
fetchRemoteBranches(request, callback)
fetchRemoteBranches
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IFetchRemoteBranchesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesResponse
, protos.google.cloud.dataform.v1beta1.IFetchRemoteBranchesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getCompilationResult(request, options)
getCompilationResult
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
|
undefined
),
{}
|
undefined
]>;
Fetches a single CompilationResult.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.ICompilationResult
,
( protos.google.cloud.dataform.v1beta1.IGetCompilationResultRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The compilation result's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callGetCompilationResult
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
getCompilationResult
(
request
);
console
.
log
(
response
);
}
callGetCompilationResult
();
getCompilationResult(request, options, callback)
getCompilationResult
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.ICompilationResult
, protos.google.cloud.dataform.v1beta1.IGetCompilationResultRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getCompilationResult(request, callback)
getCompilationResult
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetCompilationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.ICompilationResult
, protos.google.cloud.dataform.v1beta1.IGetCompilationResultRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
GetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
Policy
]>;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
Name
Description
request
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.Policy
, google.iam.v1.GetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Returns
Type
Description
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
Parameters
Name
Description
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
Type
Description
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter
Name
Description
callback
Callback
<string, undefined, undefined>
Returns
Type
Description
void
getRepository(request, options)
getRepository
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
|
undefined
,
{}
|
undefined
]>;
Fetches a single Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IGetRepositoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callGetRepository
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
getRepository
(
request
);
console
.
log
(
response
);
}
callGetRepository
();
getRepository(request, options, callback)
getRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IGetRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getRepository(request, callback)
getRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IGetRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getWorkflowInvocation(request, options)
getWorkflowInvocation
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
|
undefined
),
{}
|
undefined
]>;
Fetches a single WorkflowInvocation.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
,
( protos.google.cloud.dataform.v1beta1.IGetWorkflowInvocationRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workflow invocation resource's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callGetWorkflowInvocation
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
getWorkflowInvocation
(
request
);
console
.
log
(
response
);
}
callGetWorkflowInvocation
();
getWorkflowInvocation(request, options, callback)
getWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
, protos.google.cloud.dataform.v1beta1.IGetWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getWorkflowInvocation(request, callback)
getWorkflowInvocation
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkflowInvocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
, protos.google.cloud.dataform.v1beta1.IGetWorkflowInvocationRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getWorkspace(request, options)
getWorkspace
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
|
undefined
,
{}
|
undefined
]>;
Fetches a single Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.IGetWorkspaceRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Workspace . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callGetWorkspace
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
getWorkspace
(
request
);
console
.
log
(
response
);
}
callGetWorkspace
();
getWorkspace(request, options, callback)
getWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.IGetWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
getWorkspace(request, callback)
getWorkspace
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IGetWorkspaceRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWorkspace
, protos.google.cloud.dataform.v1beta1.IGetWorkspaceRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
installNpmPackages(request, options)
installNpmPackages
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesResponse
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
|
undefined
),
{}
|
undefined
]>;
Installs dependency NPM packages (inside a Workspace).
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesResponse
,
( protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing InstallNpmPackagesResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callInstallNpmPackages
()
{
// Construct request
const
request
=
{
workspace
,
};
// Run request
const
response
=
await
dataformClient
.
installNpmPackages
(
request
);
console
.
log
(
response
);
}
callInstallNpmPackages
();
installNpmPackages(request, options, callback)
installNpmPackages
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesResponse
, protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
installNpmPackages(request, callback)
installNpmPackages
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IInstallNpmPackagesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesResponse
, protos.google.cloud.dataform.v1beta1.IInstallNpmPackagesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
listCompilationResults(request, options)
listCompilationResults
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsResponse
]>;
Lists CompilationResults in a given Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.ICompilationResult
[], protos.google.cloud.dataform.v1beta1.IListCompilationResultsRequest
| null, protos.google.cloud.dataform.v1beta1.IListCompilationResultsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCompilationResultsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listCompilationResults(request, options, callback)
listCompilationResults
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Returns
Type
Description
void
listCompilationResults(request, callback)
listCompilationResults
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
> )
:
void
;
Parameters
Name
Description
request
callback
Returns
Type
Description
void
listCompilationResultsAsync(request, options)
listCompilationResultsAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResult
> ;
Equivalent to listCompilationResults
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.ICompilationResult
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository in which to list compilation results. Must be in the
* format `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of compilation results to return. The server may return
* fewer items than requested. If unspecified, the server will pick an
* appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListCompilationResults` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListCompilationResults`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callListCompilationResults
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataformClient
.
listCompilationResultsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListCompilationResults
();
listCompilationResultsStream(request, options)
listCompilationResultsStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListCompilationResultsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCompilationResultsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
Returns
Type
Description
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listRepositories(request, options)
listRepositories
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesResponse
]>;
Lists Repositories in a given project and location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IRepository
[], protos.google.cloud.dataform.v1beta1.IListRepositoriesRequest
| null, protos.google.cloud.dataform.v1beta1.IListRepositoriesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRepositoriesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRepositories(request, options, callback)
listRepositories
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.dataform.v1beta1.IListRepositoriesRequest
, protos.google.cloud.dataform.v1beta1.IListRepositoriesResponse
| null | undefined, protos.google.cloud.dataform.v1beta1.IRepository
>
Returns
Type
Description
void
listRepositories(request, callback)
listRepositories
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
> )
:
void
;
Parameters
Name
Description
request
callback
PaginationCallback
< protos.google.cloud.dataform.v1beta1.IListRepositoriesRequest
, protos.google.cloud.dataform.v1beta1.IListRepositoriesResponse
| null | undefined, protos.google.cloud.dataform.v1beta1.IRepository
>
Returns
Type
Description
void
listRepositoriesAsync(request, options)
listRepositoriesAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
> ;
Equivalent to listRepositories
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.IRepository
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location in which to list repositories. Must be in the format
* `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of repositories to return. The server may return fewer
* items than requested. If unspecified, the server will pick an appropriate
* default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListRepositories` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListRepositories`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. This field only supports ordering by `name`. If unspecified, the server
* will choose the ordering. If specified, the default order is ascending for
* the `name` field.
*/
// const orderBy = 'abc123'
/**
* Optional. Filter for the returned list.
*/
// const filter = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callListRepositories
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataformClient
.
listRepositoriesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListRepositories
();
listRepositoriesStream(request, options)
listRepositoriesStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListRepositoriesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRepositoriesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listWorkflowInvocations(request, options)
listWorkflowInvocations
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsResponse
]>;
Lists WorkflowInvocations in a given Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
[], protos.google.cloud.dataform.v1beta1.IListWorkflowInvocationsRequest
| null, protos.google.cloud.dataform.v1beta1.IListWorkflowInvocationsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listWorkflowInvocationsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listWorkflowInvocations(request, options, callback)
listWorkflowInvocations
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Returns
Type
Description
void
listWorkflowInvocations(request, callback)
listWorkflowInvocations
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
> )
:
void
;
Parameters
Name
Description
request
callback
Returns
Type
Description
void
listWorkflowInvocationsAsync(request, options)
listWorkflowInvocationsAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocation
> ;
Equivalent to listWorkflowInvocations
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource of the WorkflowInvocation type. Must be in the
* format `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of workflow invocations to return. The server may return
* fewer items than requested. If unspecified, the server will pick an
* appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListWorkflowInvocations` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListWorkflowInvocations`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callListWorkflowInvocations
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataformClient
.
listWorkflowInvocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListWorkflowInvocations
();
listWorkflowInvocationsStream(request, options)
listWorkflowInvocationsStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkflowInvocationsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listWorkflowInvocationsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listWorkspaces(request, options)
listWorkspaces
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesResponse
]>;
Lists Workspaces in a given Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkspace
[], protos.google.cloud.dataform.v1beta1.IListWorkspacesRequest
| null, protos.google.cloud.dataform.v1beta1.IListWorkspacesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Workspace
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listWorkspacesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listWorkspaces(request, options, callback)
listWorkspaces
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.dataform.v1beta1.IListWorkspacesRequest
, protos.google.cloud.dataform.v1beta1.IListWorkspacesResponse
| null | undefined, protos.google.cloud.dataform.v1beta1.IWorkspace
>
Returns
Type
Description
void
listWorkspaces(request, callback)
listWorkspaces
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
> )
:
void
;
Parameters
Name
Description
request
callback
PaginationCallback
< protos.google.cloud.dataform.v1beta1.IListWorkspacesRequest
, protos.google.cloud.dataform.v1beta1.IListWorkspacesResponse
| null | undefined, protos.google.cloud.dataform.v1beta1.IWorkspace
>
Returns
Type
Description
void
listWorkspacesAsync(request, options)
listWorkspacesAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkspace
> ;
Equivalent to listWorkspaces
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.IWorkspace
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Workspace . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The repository in which to list workspaces. Must be in the
* format `projects/* /locations/* /repositories/*`.
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of workspaces to return. The server may return fewer
* items than requested. If unspecified, the server will pick an appropriate
* default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListWorkspaces` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListWorkspaces`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Optional. This field only supports ordering by `name`. If unspecified, the server
* will choose the ordering. If specified, the default order is ascending for
* the `name` field.
*/
// const orderBy = 'abc123'
/**
* Optional. Filter for the returned list.
*/
// const filter = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callListWorkspaces
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataformClient
.
listWorkspacesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListWorkspaces
();
listWorkspacesStream(request, options)
listWorkspacesStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IListWorkspacesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing Workspace
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listWorkspacesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
Parameters
Name
Description
project
string
location
string
Returns
Type
Description
string
{string} Resource name string.
makeDirectory(request, options)
makeDirectory
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
|
undefined
,
{}
|
undefined
]>;
Creates a directory inside a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IMakeDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMakeDirectoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing MakeDirectoryResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The directory's full path including directory name, relative to the
* workspace root.
*/
// const path = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callMakeDirectory
()
{
// Construct request
const
request
=
{
workspace
,
path
,
};
// Run request
const
response
=
await
dataformClient
.
makeDirectory
(
request
);
console
.
log
(
response
);
}
callMakeDirectory
();
makeDirectory(request, options, callback)
makeDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMakeDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMakeDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
makeDirectory(request, callback)
makeDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMakeDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMakeDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMakeDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
matchCompilationResultFromCompilationResultName(compilationResultName)
matchCompilationResultFromCompilationResultName
(
compilationResultName
:
string
)
:
string
|
number
;
Parse the compilation_result from CompilationResult resource.
Parameter
Name
Description
compilationResultName
string
A fully-qualified path representing CompilationResult resource.
Returns
Type
Description
string | number
{string} A string representing the compilation_result.
matchLocationFromCompilationResultName(compilationResultName)
matchLocationFromCompilationResultName
(
compilationResultName
:
string
)
:
string
|
number
;
Parse the location from CompilationResult resource.
Parameter
Name
Description
compilationResultName
string
A fully-qualified path representing CompilationResult resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter
Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromRepositoryName(repositoryName)
matchLocationFromRepositoryName
(
repositoryName
:
string
)
:
string
|
number
;
Parse the location from Repository resource.
Parameter
Name
Description
repositoryName
string
A fully-qualified path representing Repository resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromWorkflowInvocationName(workflowInvocationName)
matchLocationFromWorkflowInvocationName
(
workflowInvocationName
:
string
)
:
string
|
number
;
Parse the location from WorkflowInvocation resource.
Parameter
Name
Description
workflowInvocationName
string
A fully-qualified path representing WorkflowInvocation resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchLocationFromWorkspaceName(workspaceName)
matchLocationFromWorkspaceName
(
workspaceName
:
string
)
:
string
|
number
;
Parse the location from Workspace resource.
Parameter
Name
Description
workspaceName
string
A fully-qualified path representing Workspace resource.
Returns
Type
Description
string | number
{string} A string representing the location.
matchProjectFromCompilationResultName(compilationResultName)
matchProjectFromCompilationResultName
(
compilationResultName
:
string
)
:
string
|
number
;
Parse the project from CompilationResult resource.
Parameter
Name
Description
compilationResultName
string
A fully-qualified path representing CompilationResult resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter
Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromRepositoryName(repositoryName)
matchProjectFromRepositoryName
(
repositoryName
:
string
)
:
string
|
number
;
Parse the project from Repository resource.
Parameter
Name
Description
repositoryName
string
A fully-qualified path representing Repository resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromWorkflowInvocationName(workflowInvocationName)
matchProjectFromWorkflowInvocationName
(
workflowInvocationName
:
string
)
:
string
|
number
;
Parse the project from WorkflowInvocation resource.
Parameter
Name
Description
workflowInvocationName
string
A fully-qualified path representing WorkflowInvocation resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchProjectFromWorkspaceName(workspaceName)
matchProjectFromWorkspaceName
(
workspaceName
:
string
)
:
string
|
number
;
Parse the project from Workspace resource.
Parameter
Name
Description
workspaceName
string
A fully-qualified path representing Workspace resource.
Returns
Type
Description
string | number
{string} A string representing the project.
matchRepositoryFromCompilationResultName(compilationResultName)
matchRepositoryFromCompilationResultName
(
compilationResultName
:
string
)
:
string
|
number
;
Parse the repository from CompilationResult resource.
Parameter
Name
Description
compilationResultName
string
A fully-qualified path representing CompilationResult resource.
Returns
Type
Description
string | number
{string} A string representing the repository.
matchRepositoryFromRepositoryName(repositoryName)
matchRepositoryFromRepositoryName
(
repositoryName
:
string
)
:
string
|
number
;
Parse the repository from Repository resource.
Parameter
Name
Description
repositoryName
string
A fully-qualified path representing Repository resource.
Returns
Type
Description
string | number
{string} A string representing the repository.
matchRepositoryFromWorkflowInvocationName(workflowInvocationName)
matchRepositoryFromWorkflowInvocationName
(
workflowInvocationName
:
string
)
:
string
|
number
;
Parse the repository from WorkflowInvocation resource.
Parameter
Name
Description
workflowInvocationName
string
A fully-qualified path representing WorkflowInvocation resource.
Returns
Type
Description
string | number
{string} A string representing the repository.
matchRepositoryFromWorkspaceName(workspaceName)
matchRepositoryFromWorkspaceName
(
workspaceName
:
string
)
:
string
|
number
;
Parse the repository from Workspace resource.
Parameter
Name
Description
workspaceName
string
A fully-qualified path representing Workspace resource.
Returns
Type
Description
string | number
{string} A string representing the repository.
matchWorkflowInvocationFromWorkflowInvocationName(workflowInvocationName)
matchWorkflowInvocationFromWorkflowInvocationName
(
workflowInvocationName
:
string
)
:
string
|
number
;
Parse the workflow_invocation from WorkflowInvocation resource.
Parameter
Name
Description
workflowInvocationName
string
A fully-qualified path representing WorkflowInvocation resource.
Returns
Type
Description
string | number
{string} A string representing the workflow_invocation.
matchWorkspaceFromWorkspaceName(workspaceName)
matchWorkspaceFromWorkspaceName
(
workspaceName
:
string
)
:
string
|
number
;
Parse the workspace from Workspace resource.
Parameter
Name
Description
workspaceName
string
A fully-qualified path representing Workspace resource.
Returns
Type
Description
string | number
{string} A string representing the workspace.
moveDirectory(request, options)
moveDirectory
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
|
undefined
,
{}
|
undefined
]>;
Moves a directory (inside a Workspace), and all of its contents, to a new location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IMoveDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMoveDirectoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing MoveDirectoryResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The directory's full path including directory name, relative to the
* workspace root.
*/
// const path = 'abc123'
/**
* Required. The new path for the directory including directory name, rooted at
* workspace root.
*/
// const newPath = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callMoveDirectory
()
{
// Construct request
const
request
=
{
workspace
,
path
,
newPath
,
};
// Run request
const
response
=
await
dataformClient
.
moveDirectory
(
request
);
console
.
log
(
response
);
}
callMoveDirectory
();
moveDirectory(request, options, callback)
moveDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMoveDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMoveDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
moveDirectory(request, callback)
moveDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMoveDirectoryResponse
, protos.google.cloud.dataform.v1beta1.IMoveDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
moveFile(request, options)
moveFile
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
|
undefined
,
{}
|
undefined
]>;
Moves a file (inside a Workspace) to a new location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IMoveFileResponse
, protos.google.cloud.dataform.v1beta1.IMoveFileRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing MoveFileResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The file's full path including filename, relative to the workspace root.
*/
// const path = 'abc123'
/**
* Required. The file's new path including filename, relative to the workspace root.
*/
// const newPath = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callMoveFile
()
{
// Construct request
const
request
=
{
workspace
,
path
,
newPath
,
};
// Run request
const
response
=
await
dataformClient
.
moveFile
(
request
);
console
.
log
(
response
);
}
callMoveFile
();
moveFile(request, options, callback)
moveFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMoveFileResponse
, protos.google.cloud.dataform.v1beta1.IMoveFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
moveFile(request, callback)
moveFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IMoveFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IMoveFileResponse
, protos.google.cloud.dataform.v1beta1.IMoveFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
pullGitCommits(request, options)
pullGitCommits
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
|
undefined
,
{}
|
undefined
]>;
Pulls Git commits from the Repository's remote into a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPullGitCommitsRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
/**
* Optional. The name of the branch in the Git remote from which to pull commits.
* If left unset, the repository's default branch name will be used.
*/
// const remoteBranch = 'abc123'
/**
* Required. The author of any merge commit which may be created as a result of merging
* fetched Git commits into this workspace.
*/
// const author = {}
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callPullGitCommits
()
{
// Construct request
const
request
=
{
name
,
author
,
};
// Run request
const
response
=
await
dataformClient
.
pullGitCommits
(
request
);
console
.
log
(
response
);
}
callPullGitCommits
();
pullGitCommits(request, options, callback)
pullGitCommits
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPullGitCommitsRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
pullGitCommits(request, callback)
pullGitCommits
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPullGitCommitsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPullGitCommitsRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
pushGitCommits(request, options)
pushGitCommits
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
|
undefined
,
{}
|
undefined
]>;
Pushes Git commits from a Workspace to the Repository's remote.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPushGitCommitsRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
/**
* Optional. The name of the branch in the Git remote to which commits should be pushed.
* If left unset, the repository's default branch name will be used.
*/
// const remoteBranch = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callPushGitCommits
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
pushGitCommits
(
request
);
console
.
log
(
response
);
}
callPushGitCommits
();
pushGitCommits(request, options, callback)
pushGitCommits
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPushGitCommitsRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
pushGitCommits(request, callback)
pushGitCommits
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IPushGitCommitsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IPushGitCommitsRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
queryCompilationResultActions(request, options)
queryCompilationResultActions
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResultAction
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsResponse
]>;
Returns CompilationResultActions in a given CompilationResult.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.ICompilationResultAction
[], protos.google.cloud.dataform.v1beta1.IQueryCompilationResultActionsRequest
| null, protos.google.cloud.dataform.v1beta1.IQueryCompilationResultActionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using queryCompilationResultActionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
queryCompilationResultActions(request, options, callback)
queryCompilationResultActions
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResultAction
> )
:
void
;
Parameters
Name
Description
options
CallOptions
callback
Returns
Type
Description
void
queryCompilationResultActions(request, callback)
queryCompilationResultActions
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResultAction
> )
:
void
;
Parameters
Name
Description
callback
Returns
Type
Description
void
queryCompilationResultActionsAsync(request, options)
queryCompilationResultActionsAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
ICompilationResultAction
> ;
Equivalent to queryCompilationResultActions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.ICompilationResultAction
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The compilation result's name.
*/
// const name = 'abc123'
/**
* Optional. Maximum number of compilation results to return. The server may return
* fewer items than requested. If unspecified, the server will pick an
* appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `QueryCompilationResultActions` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `QueryCompilationResultActions` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* Optional. Optional filter for the returned list. Filtering is only currently
* supported on the `file_path` field.
*/
// const filter = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callQueryCompilationResultActions
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
iterable
=
await
dataformClient
.
queryCompilationResultActionsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callQueryCompilationResultActions
();
queryCompilationResultActionsStream(request, options)
queryCompilationResultActionsStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryCompilationResultActionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using queryCompilationResultActionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
queryDirectoryContents(request, options)
queryDirectoryContents
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
QueryDirectoryContentsResponse
.
IDirectoryEntry
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsResponse
]>;
Returns the contents of a given Workspace directory.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse.IDirectoryEntry
[], protos.google.cloud.dataform.v1beta1.IQueryDirectoryContentsRequest
| null, protos.google.cloud.dataform.v1beta1.IQueryDirectoryContentsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using queryDirectoryContentsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
queryDirectoryContents(request, options, callback)
queryDirectoryContents
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
QueryDirectoryContentsResponse
.
IDirectoryEntry
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Returns
Type
Description
void
queryDirectoryContents(request, callback)
queryDirectoryContents
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
QueryDirectoryContentsResponse
.
IDirectoryEntry
> )
:
void
;
Parameters
Name
Description
request
callback
Returns
Type
Description
void
queryDirectoryContentsAsync(request, options)
queryDirectoryContentsAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
QueryDirectoryContentsResponse
.
IDirectoryEntry
> ;
Equivalent to queryDirectoryContents
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse.IDirectoryEntry
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Optional. The directory's full path including directory name, relative to the
* workspace root. If left unset, the workspace root is used.
*/
// const path = 'abc123'
/**
* Optional. Maximum number of paths to return. The server may return fewer
* items than requested. If unspecified, the server will pick an appropriate
* default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `QueryDirectoryContents` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `QueryDirectoryContents` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callQueryDirectoryContents
()
{
// Construct request
const
request
=
{
workspace
,
};
// Run request
const
iterable
=
await
dataformClient
.
queryDirectoryContentsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callQueryDirectoryContents
();
queryDirectoryContentsStream(request, options)
queryDirectoryContentsStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryDirectoryContentsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using queryDirectoryContentsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
queryWorkflowInvocationActions(request, options)
queryWorkflowInvocationActions
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocationAction
[],
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
|
null
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsResponse
]>;
Returns WorkflowInvocationActions in a given WorkflowInvocation.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWorkflowInvocationAction
[], protos.google.cloud.dataform.v1beta1.IQueryWorkflowInvocationActionsRequest
| null, protos.google.cloud.dataform.v1beta1.IQueryWorkflowInvocationActionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using queryWorkflowInvocationActionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
queryWorkflowInvocationActions(request, options, callback)
queryWorkflowInvocationActions
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocationAction
> )
:
void
;
Parameters
Name
Description
options
CallOptions
callback
Returns
Type
Description
void
queryWorkflowInvocationActions(request, callback)
queryWorkflowInvocationActions
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocationAction
> )
:
void
;
Parameters
Name
Description
callback
Returns
Type
Description
void
queryWorkflowInvocationActionsAsync(request, options)
queryWorkflowInvocationActionsAsync
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWorkflowInvocationAction
> ;
Equivalent to queryWorkflowInvocationActions
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name
Description
request
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.dataform.v1beta1.IWorkflowInvocationAction
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workflow invocation's name.
*/
// const name = 'abc123'
/**
* Optional. Maximum number of workflow invocations to return. The server may return
* fewer items than requested. If unspecified, the server will pick an
* appropriate default.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `QueryWorkflowInvocationActions` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `QueryWorkflowInvocationActions` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callQueryWorkflowInvocationActions
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
iterable
=
await
dataformClient
.
queryWorkflowInvocationActionsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callQueryWorkflowInvocationActions
();
queryWorkflowInvocationActionsStream(request, options)
queryWorkflowInvocationActionsStream
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IQueryWorkflowInvocationActionsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using queryWorkflowInvocationActionsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
readFile(request, options)
readFile
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
|
undefined
,
{}
|
undefined
]>;
Returns the contents of a file (inside a Workspace).
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IReadFileResponse
, protos.google.cloud.dataform.v1beta1.IReadFileRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing ReadFileResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The file's full path including filename, relative to the workspace root.
*/
// const path = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callReadFile
()
{
// Construct request
const
request
=
{
workspace
,
path
,
};
// Run request
const
response
=
await
dataformClient
.
readFile
(
request
);
console
.
log
(
response
);
}
callReadFile
();
readFile(request, options, callback)
readFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IReadFileResponse
, protos.google.cloud.dataform.v1beta1.IReadFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
readFile(request, callback)
readFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IReadFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IReadFileResponse
, protos.google.cloud.dataform.v1beta1.IReadFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
removeDirectory(request, options)
removeDirectory
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
|
undefined
,
{}
|
undefined
]>;
Deletes a directory (inside a Workspace) and all of its contents.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveDirectoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The directory's full path including directory name, relative to the
* workspace root.
*/
// const path = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callRemoveDirectory
()
{
// Construct request
const
request
=
{
workspace
,
path
,
};
// Run request
const
response
=
await
dataformClient
.
removeDirectory
(
request
);
console
.
log
(
response
);
}
callRemoveDirectory
();
removeDirectory(request, options, callback)
removeDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
removeDirectory(request, callback)
removeDirectory
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveDirectoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveDirectoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
removeFile(request, options)
removeFile
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
|
undefined
,
{}
|
undefined
]>;
Deletes a file (inside a Workspace).
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveFileRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The file's full path including filename, relative to the workspace root.
*/
// const path = 'abc123'
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callRemoveFile
()
{
// Construct request
const
request
=
{
workspace
,
path
,
};
// Run request
const
response
=
await
dataformClient
.
removeFile
(
request
);
console
.
log
(
response
);
}
callRemoveFile
();
removeFile(request, options, callback)
removeFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
removeFile(request, callback)
removeFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRemoveFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IRemoveFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
repositoryPath(project, location, repository)
repositoryPath
(
project
:
string
,
location
:
string
,
repository
:
string
)
:
string
;
Return a fully-qualified repository resource name string.
Parameters
Name
Description
project
string
location
string
repository
string
Returns
Type
Description
string
{string} Resource name string.
resetWorkspaceChanges(request, options)
resetWorkspaceChanges
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
|
undefined
),
{}
|
undefined
]>;
Performs a Git reset for uncommitted files in a Workspace.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.protobuf.IEmpty
,
( protos.google.cloud.dataform.v1beta1.IResetWorkspaceChangesRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const name = 'abc123'
/**
* Optional. Full file paths to reset back to their committed state including filename,
* rooted at workspace root. If left empty, all files will be reset.
*/
// const paths = ['abc','def']
/**
* Optional. If set to true, untracked files will be deleted.
*/
// const clean = true
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callResetWorkspaceChanges
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataformClient
.
resetWorkspaceChanges
(
request
);
console
.
log
(
response
);
}
callResetWorkspaceChanges
();
resetWorkspaceChanges(request, options, callback)
resetWorkspaceChanges
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IResetWorkspaceChangesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
resetWorkspaceChanges(request, callback)
resetWorkspaceChanges
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IResetWorkspaceChangesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dataform.v1beta1.IResetWorkspaceChangesRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
Policy
,
IamProtos
.
google
.
iam
.
v1
.
SetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
Policy
]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
Name
Description
request
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.Policy
, google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.Policy
, google.iam.v1.SetIamPolicyRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Returns
Type
Description
Promise
<[ google.iam.v1.Policy
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
,
options
?:
gax
.
CallOptions
|
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
,
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise
< [
IamProtos
.
google
.
iam
.
v1
.
TestIamPermissionsResponse
]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
Name
Description
request
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.iam.v1.TestIamPermissionsResponse
, google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< google.iam.v1.TestIamPermissionsResponse
, google.iam.v1.TestIamPermissionsRequest
| null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
Returns
Type
Description
Promise
<[ google.iam.v1.TestIamPermissionsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
updateRepository(request, options)
updateRepository
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
|
undefined
,
{}
|
undefined
]>;
Updates a single Repository.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IUpdateRepositoryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. Specifies the fields to be updated in the repository. If left unset,
* all fields will be updated.
*/
// const updateMask = {}
/**
* Required. The repository to update.
*/
// const repository = {}
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callUpdateRepository
()
{
// Construct request
const
request
=
{
repository
,
};
// Run request
const
response
=
await
dataformClient
.
updateRepository
(
request
);
console
.
log
(
response
);
}
callUpdateRepository
();
updateRepository(request, options, callback)
updateRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IUpdateRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
updateRepository(request, callback)
updateRepository
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IRepository
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IUpdateRepositoryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IRepository
, protos.google.cloud.dataform.v1beta1.IUpdateRepositoryRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
workflowInvocationPath(project, location, repository, workflowInvocation)
workflowInvocationPath
(
project
:
string
,
location
:
string
,
repository
:
string
,
workflowInvocation
:
string
)
:
string
;
Return a fully-qualified workflowInvocation resource name string.
Parameters
Name
Description
project
string
location
string
repository
string
workflowInvocation
string
Returns
Type
Description
string
{string} Resource name string.
workspacePath(project, location, repository, workspace)
workspacePath
(
project
:
string
,
location
:
string
,
repository
:
string
,
workspace
:
string
)
:
string
;
Return a fully-qualified workspace resource name string.
Parameters
Name
Description
project
string
location
string
repository
string
workspace
string
Returns
Type
Description
string
{string} Resource name string.
writeFile(request, options)
writeFile
(
request
?:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
|
undefined
,
{}
|
undefined
]>;
Writes to a file (inside a Workspace).
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.dataform.v1beta1.IWriteFileResponse
, protos.google.cloud.dataform.v1beta1.IWriteFileRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing WriteFileResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The workspace's name.
*/
// const workspace = 'abc123'
/**
* Required. The file.
*/
// const path = 'abc123'
/**
* Required. The file's contents.
*/
// const contents = Buffer.from('string')
// Imports the Dataform library
const
{
DataformClient
}
=
require
(
' @google-cloud/dataform
'
).
v1beta1
;
// Instantiates a client
const
dataformClient
=
new
DataformClient
();
async
function
callWriteFile
()
{
// Construct request
const
request
=
{
workspace
,
path
,
contents
,
};
// Run request
const
response
=
await
dataformClient
.
writeFile
(
request
);
console
.
log
(
response
);
}
callWriteFile
();
writeFile(request, options, callback)
writeFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWriteFileResponse
, protos.google.cloud.dataform.v1beta1.IWriteFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
writeFile(request, callback)
writeFile
(
request
:
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileResponse
,
protos
.
google
.
cloud
.
dataform
.
v1beta1
.
IWriteFileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.dataform.v1beta1.IWriteFileResponse
, protos.google.cloud.dataform.v1beta1.IWriteFileRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
