Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
DataformClient(DataformClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
DataformClient const &
|
DataformClient(DataformClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
DataformClient &&
|
DataformClient(std::shared_ptr< DataformConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< DataformConnection >
|
opts |
Options
|
Operators
operator=(DataformClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
DataformClient const &
|
| Returns | |
|---|---|
| Type | Description |
DataformClient & |
|
operator=(DataformClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
DataformClient &&
|
| Returns | |
|---|---|
| Type | Description |
DataformClient & |
|
Functions
GetTeamFolder(std::string const &, Options)
Fetches a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The TeamFolder's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTeamFolder(google::cloud::dataform::v1::GetTeamFolderRequest const &, Options)
Fetches a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetTeamFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTeamFolder(std::string const &, google::cloud::dataform::v1::TeamFolder const &, Options)
Creates a new TeamFolder in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The location in which to create the TeamFolder. Must be in the format |
team_folder |
google::cloud::dataform::v1::TeamFolder const &
Required. The TeamFolder to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTeamFolder(google::cloud::dataform::v1::CreateTeamFolderRequest const &, Options)
Creates a new TeamFolder in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateTeamFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTeamFolder(google::cloud::dataform::v1::TeamFolder const &, google::protobuf::FieldMask const &, Options)
Updates a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
team_folder |
google::cloud::dataform::v1::TeamFolder const &
Required. The updated TeamFolder. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the Folder. If left unset, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTeamFolder(google::cloud::dataform::v1::UpdateTeamFolderRequest const &, Options)
Updates a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateTeamFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::TeamFolder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.TeamFolder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteTeamFolder(std::string const &, Options)
Deletes a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The TeamFolder's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteTeamFolder(google::cloud::dataform::v1::DeleteTeamFolderRequest const &, Options)
Deletes a single TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteTeamFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteTeamFolderTree(std::string const &, bool, Options)
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder} |
force |
bool
Optional. If |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
A |
DeleteTeamFolderTree(NoAwaitTag, std::string const &, bool, Options)
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
force |
bool
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteTeamFolderTree(google::cloud::dataform::v1::DeleteTeamFolderTreeRequest const &, Options)
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteTeamFolderTreeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
A |
DeleteTeamFolderTree(NoAwaitTag, google::cloud::dataform::v1::DeleteTeamFolderTreeRequest const &, Options)
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataform::v1::DeleteTeamFolderTreeRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteTeamFolderTree(google::longrunning::Operation const &, Options)
Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
|
QueryTeamFolderContents(std::string const &, Options)
Returns the contents of a given TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
team_folder |
std::string const &
Required. Name of the team_folder whose contents to list. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
QueryTeamFolderContents(google::cloud::dataform::v1::QueryTeamFolderContentsRequest, Options)
Returns the contents of a given TeamFolder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryTeamFolderContentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchTeamFolders(google::cloud::dataform::v1::SearchTeamFoldersRequest, Options)
Returns all TeamFolders in a given location that the caller has access to and match the provided filter.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::SearchTeamFoldersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::SearchTeamFoldersResponse::TeamFolderSearchResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetFolder(std::string const &, Options)
Fetches a single Folder.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The Folder's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFolder(google::cloud::dataform::v1::GetFolderRequest const &, Options)
Fetches a single Folder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFolder(std::string const &, google::cloud::dataform::v1::Folder const &, Options)
Creates a new Folder in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The location in which to create the Folder. Must be in the format |
folder |
google::cloud::dataform::v1::Folder const &
Required. The Folder to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFolder(google::cloud::dataform::v1::CreateFolderRequest const &, Options)
Creates a new Folder in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateFolder(google::cloud::dataform::v1::Folder const &, google::protobuf::FieldMask const &, Options)
Updates a single Folder.
| Parameters | |
|---|---|
| Name | Description |
folder |
google::cloud::dataform::v1::Folder const &
Required. The updated Folder. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name). |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateFolder(google::cloud::dataform::v1::UpdateFolderRequest const &, Options)
Updates a single Folder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Folder > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Folder) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteFolder(std::string const &, Options)
Deletes a single Folder.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The Folder's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteFolder(google::cloud::dataform::v1::DeleteFolderRequest const &, Options)
Deletes a single Folder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteFolderTree(std::string const &, bool, Options)
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder} |
force |
bool
Optional. If |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
A |
DeleteFolderTree(NoAwaitTag, std::string const &, bool, Options)
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
force |
bool
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteFolderTree(google::cloud::dataform::v1::DeleteFolderTreeRequest const &, Options)
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteFolderTreeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
A |
DeleteFolderTree(NoAwaitTag, google::cloud::dataform::v1::DeleteFolderTreeRequest const &, Options)
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataform::v1::DeleteFolderTreeRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteFolderTree(google::longrunning::Operation const &, Options)
Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::DeleteFolderTreeMetadata > > |
|
QueryFolderContents(std::string const &, Options)
Returns the contents of a given Folder.
| Parameters | |
|---|---|
| Name | Description |
folder |
std::string const &
Required. Name of the folder whose contents to list. Format: projects//locations//folders/* |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryFolderContentsResponse::FolderContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
QueryFolderContents(google::cloud::dataform::v1::QueryFolderContentsRequest, Options)
Returns the contents of a given Folder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryFolderContentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryFolderContentsResponse::FolderContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
QueryUserRootContents(std::string const &, Options)
Returns the contents of a caller's root folder in a given location.
The root folder contains all resources that are created by the user and not contained in any other folder.
| Parameters | |
|---|---|
| Name | Description |
location |
std::string const &
Required. Location of the user root folder whose contents to list. Format: projects//locations/ |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryUserRootContentsResponse::RootContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
QueryUserRootContents(google::cloud::dataform::v1::QueryUserRootContentsRequest, Options)
Returns the contents of a caller's root folder in a given location.
The root folder contains all resources that are created by the user and not contained in any other folder.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryUserRootContentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::QueryUserRootContentsResponse::RootContentsEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
MoveFolder(std::string const &, std::string const &, Options)
Moves a Folder to a new Folder, TeamFolder, or the root location.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The full resource name of the Folder to move. |
destination_containing_folder |
std::string const &
Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveFolderMetadata > > |
A |
MoveFolder(NoAwaitTag, std::string const &, std::string const &, Options)
Moves a Folder to a new Folder, TeamFolder, or the root location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
destination_containing_folder |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MoveFolder(google::cloud::dataform::v1::MoveFolderRequest const &, Options)
Moves a Folder to a new Folder, TeamFolder, or the root location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::MoveFolderRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveFolderMetadata > > |
A |
MoveFolder(NoAwaitTag, google::cloud::dataform::v1::MoveFolderRequest const &, Options)
Moves a Folder to a new Folder, TeamFolder, or the root location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataform::v1::MoveFolderRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MoveFolder(google::longrunning::Operation const &, Options)
Moves a Folder to a new Folder, TeamFolder, or the root location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveFolderMetadata > > |
|
ListRepositories(std::string const &, Options)
Lists Repositories in a given project and location.
Note:This method can return repositories not shown in the *[Dataform UI*](https://console.cloud.google.com/bigquery/dataform).
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The location in which to list repositories. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::Repository > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListRepositories(google::cloud::dataform::v1::ListRepositoriesRequest, Options)
Lists Repositories in a given project and location.
Note:This method can return repositories not shown in the *[Dataform UI*](https://console.cloud.google.com/bigquery/dataform).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListRepositoriesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::Repository > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetRepository(std::string const &, Options)
Fetches a single Repository.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The repository's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetRepository(google::cloud::dataform::v1::GetRepositoryRequest const &, Options)
Fetches a single Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRepository(std::string const &, google::cloud::dataform::v1::Repository const &, std::string const &, Options)
Creates a new Repository in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The location in which to create the repository. Must be in the format |
repository |
google::cloud::dataform::v1::Repository const &
Required. The repository to create. |
repository_id |
std::string const &
Required. The ID to use for the repository, which will become the final component of the repository's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateRepository(google::cloud::dataform::v1::CreateRepositoryRequest const &, Options)
Creates a new Repository in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRepository(google::cloud::dataform::v1::Repository const &, google::protobuf::FieldMask const &, Options)
Updates a single Repository.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
repository |
google::cloud::dataform::v1::Repository const &
Required. The repository to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateRepository(google::cloud::dataform::v1::UpdateRepositoryRequest const &, Options)
Updates a single Repository.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Repository > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteRepository(std::string const &, Options)
Deletes a single Repository.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The repository's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteRepository(google::cloud::dataform::v1::DeleteRepositoryRequest const &, Options)
Deletes a single Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
MoveRepository(std::string const &, std::string const &, Options)
Moves a Repository to a new location.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The full resource name of the repository to move. |
destination_containing_folder |
std::string const &
Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveRepositoryMetadata > > |
A |
MoveRepository(NoAwaitTag, std::string const &, std::string const &, Options)
Moves a Repository to a new location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
destination_containing_folder |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MoveRepository(google::cloud::dataform::v1::MoveRepositoryRequest const &, Options)
Moves a Repository to a new location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::MoveRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveRepositoryMetadata > > |
A |
MoveRepository(NoAwaitTag, google::cloud::dataform::v1::MoveRepositoryRequest const &, Options)
Moves a Repository to a new location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::dataform::v1::MoveRepositoryRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MoveRepository(google::longrunning::Operation const &, Options)
Moves a Repository to a new location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::dataform::v1::MoveRepositoryMetadata > > |
|
CommitRepositoryChanges(google::cloud::dataform::v1::CommitRepositoryChangesRequest const &, Options)
Applies a Git commit to a Repository.
The Repository must not have a value for git_remote_settings.url.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CommitRepositoryChangesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CommitRepositoryChangesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CommitRepositoryChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadRepositoryFile(google::cloud::dataform::v1::ReadRepositoryFileRequest const &, Options)
Returns the contents of a file (inside a Repository).
The Repository must not have a value for git_remote_settings.url.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ReadRepositoryFileRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReadRepositoryFileResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReadRepositoryFileResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
QueryRepositoryDirectoryContents(google::cloud::dataform::v1::QueryRepositoryDirectoryContentsRequest, Options)
Returns the contents of a given Repository directory.
The Repository must not have a value for git_remote_settings.url.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryRepositoryDirectoryContentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::DirectoryEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
FetchRepositoryHistory(google::cloud::dataform::v1::FetchRepositoryHistoryRequest, Options)
Fetches a Repository's history of commits.
The Repository must not have a value for git_remote_settings.url.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::FetchRepositoryHistoryRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::CommitLogEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ComputeRepositoryAccessTokenStatus(google::cloud::dataform::v1::ComputeRepositoryAccessTokenStatusRequest const &, Options)
Computes a Repository's Git access token status.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ComputeRepositoryAccessTokenStatusRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ComputeRepositoryAccessTokenStatusResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ComputeRepositoryAccessTokenStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchRemoteBranches(google::cloud::dataform::v1::FetchRemoteBranchesRequest const &, Options)
Fetches a Repository's remote branches.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::FetchRemoteBranchesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::FetchRemoteBranchesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.FetchRemoteBranchesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkspaces(std::string const &, Options)
Lists Workspaces in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to list workspaces. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::Workspace > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkspaces(google::cloud::dataform::v1::ListWorkspacesRequest, Options)
Lists Workspaces in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListWorkspacesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::Workspace > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetWorkspace(std::string const &, Options)
Fetches a single Workspace.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workspace's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Workspace > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Workspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkspace(google::cloud::dataform::v1::GetWorkspaceRequest const &, Options)
Fetches a single Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetWorkspaceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Workspace > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Workspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkspace(std::string const &, google::cloud::dataform::v1::Workspace const &, std::string const &, Options)
Creates a new Workspace in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to create the workspace. Must be in the format |
workspace |
google::cloud::dataform::v1::Workspace const &
Required. The workspace to create. |
workspace_id |
std::string const &
Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Workspace > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Workspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkspace(google::cloud::dataform::v1::CreateWorkspaceRequest const &, Options)
Creates a new Workspace in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateWorkspaceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Workspace > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Workspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteWorkspace(std::string const &, Options)
Deletes a single Workspace.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workspace resource's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteWorkspace(google::cloud::dataform::v1::DeleteWorkspaceRequest const &, Options)
Deletes a single Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteWorkspaceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
InstallNpmPackages(google::cloud::dataform::v1::InstallNpmPackagesRequest const &, Options)
Installs dependency NPM packages (inside a Workspace).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::InstallNpmPackagesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::InstallNpmPackagesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.InstallNpmPackagesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PullGitCommits(google::cloud::dataform::v1::PullGitCommitsRequest const &, Options)
Pulls Git commits from the Repository's remote into a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::PullGitCommitsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::PullGitCommitsResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.PullGitCommitsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PushGitCommits(google::cloud::dataform::v1::PushGitCommitsRequest const &, Options)
Pushes Git commits from a Workspace to the Repository's remote.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::PushGitCommitsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::PushGitCommitsResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.PushGitCommitsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchFileGitStatuses(google::cloud::dataform::v1::FetchFileGitStatusesRequest const &, Options)
Fetches Git statuses for the files in a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::FetchFileGitStatusesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::FetchFileGitStatusesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.FetchFileGitStatusesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchGitAheadBehind(google::cloud::dataform::v1::FetchGitAheadBehindRequest const &, Options)
Fetches Git ahead/behind against a remote branch.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::FetchGitAheadBehindRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::FetchGitAheadBehindResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.FetchGitAheadBehindResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CommitWorkspaceChanges(google::cloud::dataform::v1::CommitWorkspaceChangesRequest const &, Options)
Applies a Git commit for uncommitted files in a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CommitWorkspaceChangesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CommitWorkspaceChangesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CommitWorkspaceChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ResetWorkspaceChanges(google::cloud::dataform::v1::ResetWorkspaceChangesRequest const &, Options)
Performs a Git reset for uncommitted files in a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ResetWorkspaceChangesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ResetWorkspaceChangesResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ResetWorkspaceChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FetchFileDiff(google::cloud::dataform::v1::FetchFileDiffRequest const &, Options)
Fetches Git diff for an uncommitted file in a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::FetchFileDiffRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::FetchFileDiffResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.FetchFileDiffResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
QueryDirectoryContents(google::cloud::dataform::v1::QueryDirectoryContentsRequest, Options)
Returns the contents of a given Workspace directory.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryDirectoryContentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::DirectoryEntry > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchFiles(google::cloud::dataform::v1::SearchFilesRequest, Options)
Finds the contents of a given Workspace directory by filter.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::SearchFilesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::SearchResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
MakeDirectory(google::cloud::dataform::v1::MakeDirectoryRequest const &, Options)
Creates a directory inside a Workspace.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::MakeDirectoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::MakeDirectoryResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.MakeDirectoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RemoveDirectory(google::cloud::dataform::v1::RemoveDirectoryRequest const &, Options)
Deletes a directory (inside a Workspace) and all of its contents.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::RemoveDirectoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::RemoveDirectoryResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.RemoveDirectoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
MoveDirectory(google::cloud::dataform::v1::MoveDirectoryRequest const &, Options)
Moves a directory (inside a Workspace), and all of its contents, to a new location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::MoveDirectoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::MoveDirectoryResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.MoveDirectoryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadFile(google::cloud::dataform::v1::ReadFileRequest const &, Options)
Returns the contents of a file (inside a Workspace).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ReadFileRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReadFileResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReadFileResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RemoveFile(google::cloud::dataform::v1::RemoveFileRequest const &, Options)
Deletes a file (inside a Workspace).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::RemoveFileRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::RemoveFileResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.RemoveFileResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
MoveFile(google::cloud::dataform::v1::MoveFileRequest const &, Options)
Moves a file (inside a Workspace) to a new location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::MoveFileRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::MoveFileResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.MoveFileResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
WriteFile(google::cloud::dataform::v1::WriteFileRequest const &, Options)
Writes to a file (inside a Workspace).
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::WriteFileRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WriteFileResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WriteFileResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListReleaseConfigs(std::string const &, Options)
Lists ReleaseConfigs in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to list release configs. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::ReleaseConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListReleaseConfigs(google::cloud::dataform::v1::ListReleaseConfigsRequest, Options)
Lists ReleaseConfigs in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListReleaseConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::ReleaseConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetReleaseConfig(std::string const &, Options)
Fetches a single ReleaseConfig.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The release config's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetReleaseConfig(google::cloud::dataform::v1::GetReleaseConfigRequest const &, Options)
Fetches a single ReleaseConfig.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetReleaseConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateReleaseConfig(std::string const &, google::cloud::dataform::v1::ReleaseConfig const &, std::string const &, Options)
Creates a new ReleaseConfig in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to create the release config. Must be in the format |
release_config |
google::cloud::dataform::v1::ReleaseConfig const &
Required. The release config to create. |
release_config_id |
std::string const &
Required. The ID to use for the release config, which will become the final component of the release config's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateReleaseConfig(google::cloud::dataform::v1::CreateReleaseConfigRequest const &, Options)
Creates a new ReleaseConfig in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateReleaseConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateReleaseConfig(google::cloud::dataform::v1::ReleaseConfig const &, google::protobuf::FieldMask const &, Options)
Updates a single ReleaseConfig.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
release_config |
google::cloud::dataform::v1::ReleaseConfig const &
Required. The release config to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateReleaseConfig(google::cloud::dataform::v1::UpdateReleaseConfigRequest const &, Options)
Updates a single ReleaseConfig.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateReleaseConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::ReleaseConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.ReleaseConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteReleaseConfig(std::string const &, Options)
Deletes a single ReleaseConfig.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The release config's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteReleaseConfig(google::cloud::dataform::v1::DeleteReleaseConfigRequest const &, Options)
Deletes a single ReleaseConfig.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteReleaseConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
ListCompilationResults(std::string const &, Options)
Lists CompilationResults in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to list compilation results. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::CompilationResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCompilationResults(google::cloud::dataform::v1::ListCompilationResultsRequest, Options)
Lists CompilationResults in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListCompilationResultsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::CompilationResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCompilationResult(std::string const &, Options)
Fetches a single CompilationResult.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The compilation result's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CompilationResult > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CompilationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCompilationResult(google::cloud::dataform::v1::GetCompilationResultRequest const &, Options)
Fetches a single CompilationResult.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetCompilationResultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CompilationResult > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CompilationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCompilationResult(std::string const &, google::cloud::dataform::v1::CompilationResult const &, Options)
Creates a new CompilationResult in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to create the compilation result. Must be in the format |
compilation_result |
google::cloud::dataform::v1::CompilationResult const &
Required. The compilation result to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CompilationResult > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CompilationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCompilationResult(google::cloud::dataform::v1::CreateCompilationResultRequest const &, Options)
Creates a new CompilationResult in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateCompilationResultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CompilationResult > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CompilationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
QueryCompilationResultActions(google::cloud::dataform::v1::QueryCompilationResultActionsRequest, Options)
Returns CompilationResultActions in a given CompilationResult.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryCompilationResultActionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::CompilationResultAction > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkflowConfigs(std::string const &, Options)
Lists WorkflowConfigs in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to list workflow configs. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::WorkflowConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkflowConfigs(google::cloud::dataform::v1::ListWorkflowConfigsRequest, Options)
Lists WorkflowConfigs in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListWorkflowConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::WorkflowConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetWorkflowConfig(std::string const &, Options)
Fetches a single WorkflowConfig.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workflow config's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkflowConfig(google::cloud::dataform::v1::GetWorkflowConfigRequest const &, Options)
Fetches a single WorkflowConfig.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetWorkflowConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkflowConfig(std::string const &, google::cloud::dataform::v1::WorkflowConfig const &, std::string const &, Options)
Creates a new WorkflowConfig in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to create the workflow config. Must be in the format |
workflow_config |
google::cloud::dataform::v1::WorkflowConfig const &
Required. The workflow config to create. |
workflow_config_id |
std::string const &
Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkflowConfig(google::cloud::dataform::v1::CreateWorkflowConfigRequest const &, Options)
Creates a new WorkflowConfig in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateWorkflowConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateWorkflowConfig(google::cloud::dataform::v1::WorkflowConfig const &, google::protobuf::FieldMask const &, Options)
Updates a single WorkflowConfig.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
workflow_config |
google::cloud::dataform::v1::WorkflowConfig const &
Required. The workflow config to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateWorkflowConfig(google::cloud::dataform::v1::UpdateWorkflowConfigRequest const &, Options)
Updates a single WorkflowConfig.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateWorkflowConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowConfig > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteWorkflowConfig(std::string const &, Options)
Deletes a single WorkflowConfig.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workflow config's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteWorkflowConfig(google::cloud::dataform::v1::DeleteWorkflowConfigRequest const &, Options)
Deletes a single WorkflowConfig.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteWorkflowConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
ListWorkflowInvocations(std::string const &, Options)
Lists WorkflowInvocations in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent resource of the WorkflowInvocation type. Must be in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::WorkflowInvocation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkflowInvocations(google::cloud::dataform::v1::ListWorkflowInvocationsRequest, Options)
Lists WorkflowInvocations in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::ListWorkflowInvocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::WorkflowInvocation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetWorkflowInvocation(std::string const &, Options)
Fetches a single WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workflow invocation resource's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowInvocation > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowInvocation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkflowInvocation(google::cloud::dataform::v1::GetWorkflowInvocationRequest const &, Options)
Fetches a single WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetWorkflowInvocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowInvocation > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowInvocation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkflowInvocation(std::string const &, google::cloud::dataform::v1::WorkflowInvocation const &, Options)
Creates a new WorkflowInvocation in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The repository in which to create the workflow invocation. Must be in the format |
workflow_invocation |
google::cloud::dataform::v1::WorkflowInvocation const &
Required. The workflow invocation resource to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowInvocation > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowInvocation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateWorkflowInvocation(google::cloud::dataform::v1::CreateWorkflowInvocationRequest const &, Options)
Creates a new WorkflowInvocation in a given Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CreateWorkflowInvocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::WorkflowInvocation > |
the result of the RPC. The response message type (google.cloud.dataform.v1.WorkflowInvocation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteWorkflowInvocation(std::string const &, Options)
Deletes a single WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The workflow invocation resource's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteWorkflowInvocation(google::cloud::dataform::v1::DeleteWorkflowInvocationRequest const &, Options)
Deletes a single WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::DeleteWorkflowInvocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelWorkflowInvocation(google::cloud::dataform::v1::CancelWorkflowInvocationRequest const &, Options)
Requests cancellation of a running WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::CancelWorkflowInvocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::CancelWorkflowInvocationResponse > |
the result of the RPC. The response message type (google.cloud.dataform.v1.CancelWorkflowInvocationResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
QueryWorkflowInvocationActions(google::cloud::dataform::v1::QueryWorkflowInvocationActionsRequest, Options)
Returns WorkflowInvocationActions in a given WorkflowInvocation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::QueryWorkflowInvocationActionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::dataform::v1::WorkflowInvocationAction > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetConfig(std::string const &, Options)
Get default config for a given project and location.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The config name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Config > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConfig(google::cloud::dataform::v1::GetConfigRequest const &, Options)
Get default config for a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::GetConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Config > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateConfig(google::cloud::dataform::v1::Config const &, google::protobuf::FieldMask const &, Options)
Update default config for a given project and location.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
config |
google::cloud::dataform::v1::Config const &
Required. The config to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Specifies the fields to be updated in the config. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Config > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateConfig(google::cloud::dataform::v1::UpdateConfigRequest const &, Options)
Update default config for a given project and location.
Note:This method does not fully implement *[AIP/134](https://google.aip.dev/134). The wildcard entry () is treated as a bad request, and when the **field_mask* is omitted, the request is treated as a full update on all modifiable fields.*
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dataform::v1::UpdateConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dataform::v1::Config > |
the result of the RPC. The response message type (google.cloud.dataform.v1.Config) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(std::string const &, Options)
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 |
resource |
std::string const &
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
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 |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
| Parameters | |
|---|---|
| Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
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 |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |