Class DataformClient (3.4.0-rc)

3.4.0-rc 3.3.0 (latest) 3.2.0 2.48.0-rc 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.0

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

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 projects/*/locations/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.Repository, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListRepositoriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.Repository, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.UpdateRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.DeleteRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CommitRepositoryChangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ReadRepositoryFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.QueryRepositoryDirectoryContentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.DirectoryEntry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.FetchRepositoryHistoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.CommitLogEntry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ComputeRepositoryAccessTokenStatusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.FetchRemoteBranchesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.Workspace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListWorkspacesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.Workspace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.DeleteWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.InstallNpmPackagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.PullGitCommitsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.PushGitCommitsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.FetchFileGitStatusesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.FetchGitAheadBehindRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CommitWorkspaceChangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ResetWorkspaceChangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.FetchFileDiffRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.QueryDirectoryContentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.DirectoryEntry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.SearchFilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.SearchResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.MakeDirectoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.RemoveDirectoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.MoveDirectoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ReadFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.RemoveFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.MoveFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.WriteFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.ReleaseConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListReleaseConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.ReleaseConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetReleaseConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateReleaseConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.UpdateReleaseConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.DeleteReleaseConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 projects/*/locations/*/repositories/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.CompilationResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListCompilationResultsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.CompilationResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetCompilationResultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateCompilationResultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.QueryCompilationResultActionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.CompilationResultAction, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/*/locations/*/repositories/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.WorkflowConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListWorkflowConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.WorkflowConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetWorkflowConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateWorkflowConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.UpdateWorkflowConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.DeleteWorkflowConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 projects/*/locations/*/repositories/*.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.WorkflowInvocation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.ListWorkflowInvocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.WorkflowInvocation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetWorkflowInvocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/*/locations/*/repositories/*.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CreateWorkflowInvocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.DeleteWorkflowInvocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.CancelWorkflowInvocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.QueryWorkflowInvocationActionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataform.v1.WorkflowInvocationAction, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.GetConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataform.v1.UpdateConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.