Class DesignCenterClient (3.14.0-rc)

Service describing handlers for resources.

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

DesignCenterClient(DesignCenterClient const &)

Copy and move support

Parameter
Name Description
DesignCenterClient const &

DesignCenterClient(DesignCenterClient &&)

Copy and move support

Parameter
Name Description
DesignCenterClient &&

DesignCenterClient(std::shared_ptr< DesignCenterConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< DesignCenterConnection >
opts Options

Operators

operator=(DesignCenterClient const &)

Copy and move support

Parameter
Name Description
DesignCenterClient const &
Returns
Type Description
DesignCenterClient &

operator=(DesignCenterClient &&)

Copy and move support

Parameter
Name Description
DesignCenterClient &&
Returns
Type Description
DesignCenterClient &

Functions

GetSpace(std::string const &, Options)

Gets details about a space.

Parameters
Name Description
name std::string const &

Required. The space name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSpace(google::cloud::designcenter::v1::GetSpaceRequest const &, Options)

Gets details about a space.

Parameters
Name Description
request google::cloud::designcenter::v1::GetSpaceRequest 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.designcenter.v1.GetSpaceRequest. 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::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSpaces(std::string const &, Options)

Lists spaces in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource, for which spaces are listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Space >

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.designcenter.v1.Space, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSpaces(google::cloud::designcenter::v1::ListSpacesRequest, Options)

Lists spaces in a given project and location.

Parameters
Name Description
request google::cloud::designcenter::v1::ListSpacesRequest

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.designcenter.v1.ListSpacesRequest. 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::designcenter::v1::Space >

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.designcenter.v1.Space, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateSpace(std::string const &, google::cloud::designcenter::v1::Space const &, std::string const &, Options)

Creates a space.

Parameters
Name Description
parent std::string const &

Required. The parent in which to create a space.

space google::cloud::designcenter::v1::Space const &

Required. The space to create.

space_id std::string const &

Required. The ID of the space to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSpace(google::cloud::designcenter::v1::CreateSpaceRequest const &, Options)

Creates a space.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateSpaceRequest 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.designcenter.v1.CreateSpaceRequest. 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::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSpace(google::cloud::designcenter::v1::Space const &, google::protobuf::FieldMask const &, Options)

Updates a space.

Parameters
Name Description
space google::cloud::designcenter::v1::Space const &

Required. The space to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the space update. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateSpace(google::cloud::designcenter::v1::UpdateSpaceRequest const &, Options)

Updates a space.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateSpaceRequest 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.designcenter.v1.UpdateSpaceRequest. 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::designcenter::v1::Space >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Space) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteSpace(std::string const &, Options)

Deletes a space.

Parameters
Name Description
name std::string const &

Required. The space 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.

DeleteSpace(google::cloud::designcenter::v1::DeleteSpaceRequest const &, Options)

Deletes a space.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteSpaceRequest 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.designcenter.v1.DeleteSpaceRequest. 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.

GetApplicationTemplate(std::string const &, Options)

Gets details about an application template.

Parameters
Name Description
name std::string const &

Required. The application template name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplicationTemplate(google::cloud::designcenter::v1::GetApplicationTemplateRequest const &, Options)

Gets details about an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::GetApplicationTemplateRequest 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.designcenter.v1.GetApplicationTemplateRequest. 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::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListApplicationTemplates(std::string const &, Options)

Lists application templates in a given space.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which to list application templates.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::ApplicationTemplate >

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.designcenter.v1.ApplicationTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListApplicationTemplates(google::cloud::designcenter::v1::ListApplicationTemplatesRequest, Options)

Lists application templates in a given space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListApplicationTemplatesRequest

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.designcenter.v1.ListApplicationTemplatesRequest. 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::designcenter::v1::ApplicationTemplate >

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.designcenter.v1.ApplicationTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateApplicationTemplate(std::string const &, google::cloud::designcenter::v1::ApplicationTemplate const &, std::string const &, Options)

Creates an application template.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which to create the application template.

application_template google::cloud::designcenter::v1::ApplicationTemplate const &

Required. The application template to create.

application_template_id std::string const &

Required. The ID of the application template to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateApplicationTemplate(google::cloud::designcenter::v1::CreateApplicationTemplateRequest const &, Options)

Creates an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateApplicationTemplateRequest 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.designcenter.v1.CreateApplicationTemplateRequest. 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::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateApplicationTemplate(google::cloud::designcenter::v1::ApplicationTemplate const &, google::protobuf::FieldMask const &, Options)

Updates an application template.

Parameters
Name Description
application_template google::cloud::designcenter::v1::ApplicationTemplate const &

Required. The application template to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the application template update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateApplicationTemplate(google::cloud::designcenter::v1::UpdateApplicationTemplateRequest const &, Options)

Updates an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateApplicationTemplateRequest 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.designcenter.v1.UpdateApplicationTemplateRequest. 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::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportApplicationTemplate(std::string const &, std::string const &, Options)

Imports to an existing application template from a given shared template.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

application_template_revision_uri std::string const &

Optional. The source URI for application template revision.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportApplicationTemplate(google::cloud::designcenter::v1::ImportApplicationTemplateRequest const &, Options)

Imports to an existing application template from a given shared template.

Parameters
Name Description
request google::cloud::designcenter::v1::ImportApplicationTemplateRequest 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.designcenter.v1.ImportApplicationTemplateRequest. 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::designcenter::v1::ApplicationTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteApplicationTemplate(std::string const &, Options)

Deletes an application template.

Parameters
Name Description
name std::string const &

Required. The application template 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.

DeleteApplicationTemplate(google::cloud::designcenter::v1::DeleteApplicationTemplateRequest const &, Options)

Deletes an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteApplicationTemplateRequest 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.designcenter.v1.DeleteApplicationTemplateRequest. 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.

CommitApplicationTemplate(std::string const &, Options)

Commits an application template to create a new revision.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CommitApplicationTemplate(google::cloud::designcenter::v1::CommitApplicationTemplateRequest const &, Options)

Commits an application template to create a new revision.

Parameters
Name Description
request google::cloud::designcenter::v1::CommitApplicationTemplateRequest 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.designcenter.v1.CommitApplicationTemplateRequest. 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::designcenter::v1::ApplicationTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SnapshotApplicationTemplate(std::string const &, Options)

Snapshots an application template to create a new revision asynchronously.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::SnapshotApplicationTemplateResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.SnapshotApplicationTemplateResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SnapshotApplicationTemplate(NoAwaitTag, std::string const &, Options)

Snapshots an application template to create a new revision asynchronously.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SnapshotApplicationTemplate(google::cloud::designcenter::v1::SnapshotApplicationTemplateRequest const &, Options)

Snapshots an application template to create a new revision asynchronously.

Parameters
Name Description
request google::cloud::designcenter::v1::SnapshotApplicationTemplateRequest 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.designcenter.v1.SnapshotApplicationTemplateRequest. 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
future< StatusOr< google::cloud::designcenter::v1::SnapshotApplicationTemplateResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.SnapshotApplicationTemplateResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SnapshotApplicationTemplate(NoAwaitTag, google::cloud::designcenter::v1::SnapshotApplicationTemplateRequest const &, Options)

Snapshots an application template to create a new revision asynchronously.

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::designcenter::v1::SnapshotApplicationTemplateRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SnapshotApplicationTemplate(google::longrunning::Operation const &, Options)

Snapshots an application template to create a new revision asynchronously.

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::designcenter::v1::SnapshotApplicationTemplateResponse > >

GenerateApplicationTemplateIaC(std::string const &, Options)

Generates Terraform files for an application template.

This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::GenerateApplicationTemplateIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationTemplateIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateApplicationTemplateIaC(google::cloud::designcenter::v1::GenerateApplicationTemplateIaCRequest const &, Options)

Generates Terraform files for an application template.

This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateApplicationTemplateIaCRequest 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.designcenter.v1.GenerateApplicationTemplateIaCRequest. 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::designcenter::v1::GenerateApplicationTemplateIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationTemplateIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ExportApplicationTemplateIaC(std::string const &, Options)

Exports Terraform files for an application template.

The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationTemplateIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationTemplateIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationTemplateIaC(NoAwaitTag, std::string const &, Options)

Exports Terraform files for an application template.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationTemplateIaC(google::cloud::designcenter::v1::ExportApplicationTemplateIaCRequest const &, Options)

Exports Terraform files for an application template.

The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.

Parameters
Name Description
request google::cloud::designcenter::v1::ExportApplicationTemplateIaCRequest 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.designcenter.v1.ExportApplicationTemplateIaCRequest. 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
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationTemplateIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationTemplateIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationTemplateIaC(NoAwaitTag, google::cloud::designcenter::v1::ExportApplicationTemplateIaCRequest const &, Options)

Exports Terraform files for an application template.

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::designcenter::v1::ExportApplicationTemplateIaCRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationTemplateIaC(google::longrunning::Operation const &, Options)

Exports Terraform files for an application template.

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::designcenter::v1::ExportApplicationTemplateIaCResponse > >

GenerateApplicationTemplateRevisionIaC(std::string const &, Options)

Generates Terraform files for an application template revision.

This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.

Parameters
Name Description
name std::string const &

Required. The name of the application template revision.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::GenerateApplicationTemplateRevisionIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationTemplateRevisionIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateApplicationTemplateRevisionIaC(google::cloud::designcenter::v1::GenerateApplicationTemplateRevisionIaCRequest const &, Options)

Generates Terraform files for an application template revision.

This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateApplicationTemplateRevisionIaCRequest 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.designcenter.v1.GenerateApplicationTemplateRevisionIaCRequest. 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::designcenter::v1::GenerateApplicationTemplateRevisionIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationTemplateRevisionIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ExportApplicationTemplateRevisionIaC(std::string const &, Options)

Exports Terraform files for an application template revision.

The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.

Parameters
Name Description
name std::string const &

Required. The name of the application template revision.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationTemplateRevisionIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationTemplateRevisionIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationTemplateRevisionIaC(NoAwaitTag, std::string const &, Options)

Exports Terraform files for an application template revision.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationTemplateRevisionIaC(google::cloud::designcenter::v1::ExportApplicationTemplateRevisionIaCRequest const &, Options)

Exports Terraform files for an application template revision.

The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.

Parameters
Name Description
request google::cloud::designcenter::v1::ExportApplicationTemplateRevisionIaCRequest 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.designcenter.v1.ExportApplicationTemplateRevisionIaCRequest. 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
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationTemplateRevisionIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationTemplateRevisionIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationTemplateRevisionIaC(NoAwaitTag, google::cloud::designcenter::v1::ExportApplicationTemplateRevisionIaCRequest const &, Options)

Exports Terraform files for an application template revision.

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::designcenter::v1::ExportApplicationTemplateRevisionIaCRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationTemplateRevisionIaC(google::longrunning::Operation const &, Options)

Exports Terraform files for an application template revision.

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::designcenter::v1::ExportApplicationTemplateRevisionIaCResponse > >

GetComponent(std::string const &, Options)

Gets details about a Component.

Parameters
Name Description
name std::string const &

Required. The component name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetComponent(google::cloud::designcenter::v1::GetComponentRequest const &, Options)

Gets details about a Component.

Parameters
Name Description
request google::cloud::designcenter::v1::GetComponentRequest 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.designcenter.v1.GetComponentRequest. 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::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListComponents(std::string const &, Options)

Lists components in an application template.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which the list of components is requested.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Component >

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.designcenter.v1.Component, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListComponents(google::cloud::designcenter::v1::ListComponentsRequest, Options)

Lists components in an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ListComponentsRequest

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.designcenter.v1.ListComponentsRequest. 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::designcenter::v1::Component >

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.designcenter.v1.Component, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateComponent(std::string const &, google::cloud::designcenter::v1::Component const &, std::string const &, Options)

Creates a component.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which to create the component.

component google::cloud::designcenter::v1::Component const &

Required. The component to create.

component_id std::string const &

Required. The ID of the component to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateComponent(google::cloud::designcenter::v1::CreateComponentRequest const &, Options)

Creates a component.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateComponentRequest 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.designcenter.v1.CreateComponentRequest. 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::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateComponent(google::cloud::designcenter::v1::Component const &, google::protobuf::FieldMask const &, Options)

Updates a component.

Parameters
Name Description
component google::cloud::designcenter::v1::Component const &

Required. The component to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the component update. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateComponent(google::cloud::designcenter::v1::UpdateComponentRequest const &, Options)

Updates a component.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateComponentRequest 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.designcenter.v1.UpdateComponentRequest. 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::designcenter::v1::Component >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Component) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteComponent(std::string const &, Options)

Deletes a component.

Parameters
Name Description
name std::string const &

Required. The component 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.

DeleteComponent(google::cloud::designcenter::v1::DeleteComponentRequest const &, Options)

Deletes a component.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteComponentRequest 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.designcenter.v1.DeleteComponentRequest. 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.

GetConnection(std::string const &, Options)

Gets details about a connection.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetConnection(google::cloud::designcenter::v1::GetConnectionRequest const &, Options)

Gets details about a connection.

Parameters
Name Description
request google::cloud::designcenter::v1::GetConnectionRequest 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.designcenter.v1.GetConnectionRequest. 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::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListConnections(std::string const &, Options)

Lists connections in an application template.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which to request a list of connections.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Connection >

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.designcenter.v1.Connection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConnections(google::cloud::designcenter::v1::ListConnectionsRequest, Options)

Lists connections in an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ListConnectionsRequest

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.designcenter.v1.ListConnectionsRequest. 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::designcenter::v1::Connection >

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.designcenter.v1.Connection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateConnection(std::string const &, google::cloud::designcenter::v1::Connection const &, std::string const &, Options)

Creates a connection.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which to create a connection.

connection google::cloud::designcenter::v1::Connection const &

Required. The connection to create.

connection_id std::string const &

Required. The ID of the connection to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateConnection(google::cloud::designcenter::v1::CreateConnectionRequest const &, Options)

Creates a connection.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateConnectionRequest 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.designcenter.v1.CreateConnectionRequest. 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::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateConnection(google::cloud::designcenter::v1::Connection const &, google::protobuf::FieldMask const &, Options)

Updates a connection.

Parameters
Name Description
connection google::cloud::designcenter::v1::Connection const &

Required. The connection to update.

update_mask google::protobuf::FieldMask const &

Optional. Fields to overwrite in the connection update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateConnection(google::cloud::designcenter::v1::UpdateConnectionRequest const &, Options)

Updates a connection.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateConnectionRequest 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.designcenter.v1.UpdateConnectionRequest. 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::designcenter::v1::Connection >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteConnection(std::string const &, Options)

Deletes a connection.

Parameters
Name Description
name std::string const &

Required. The connection 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.

DeleteConnection(google::cloud::designcenter::v1::DeleteConnectionRequest const &, Options)

Deletes a connection.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteConnectionRequest 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.designcenter.v1.DeleteConnectionRequest. 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.

GetApplicationTemplateRevision(std::string const &, Options)

Gets details about an application template revision.

Parameters
Name Description
name std::string const &

Required. The application template revision name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplicationTemplateRevision(google::cloud::designcenter::v1::GetApplicationTemplateRevisionRequest const &, Options)

Gets details about an application template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::GetApplicationTemplateRevisionRequest 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.designcenter.v1.GetApplicationTemplateRevisionRequest. 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::designcenter::v1::ApplicationTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListApplicationTemplateRevisions(std::string const &, Options)

Lists application template revisions in a given application template.

Parameters
Name Description
parent std::string const &

Required. The parent from which to list application template revisions.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::ApplicationTemplateRevision >

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.designcenter.v1.ApplicationTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListApplicationTemplateRevisions(google::cloud::designcenter::v1::ListApplicationTemplateRevisionsRequest, Options)

Lists application template revisions in a given application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ListApplicationTemplateRevisionsRequest

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.designcenter.v1.ListApplicationTemplateRevisionsRequest. 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::designcenter::v1::ApplicationTemplateRevision >

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.designcenter.v1.ApplicationTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteApplicationTemplateRevision(std::string const &, Options)

Deletes an application template revision.

Parameters
Name Description
name std::string const &

Required. The application template revision 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.

DeleteApplicationTemplateRevision(google::cloud::designcenter::v1::DeleteApplicationTemplateRevisionRequest const &, Options)

Deletes an application template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteApplicationTemplateRevisionRequest 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.designcenter.v1.DeleteApplicationTemplateRevisionRequest. 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.

GetCatalog(std::string const &, Options)

Gets details about a catalog.

Parameters
Name Description
name std::string const &

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCatalog(google::cloud::designcenter::v1::GetCatalogRequest const &, Options)

Gets details about a catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::GetCatalogRequest 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.designcenter.v1.GetCatalogRequest. 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::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListCatalogs(std::string const &, Options)

Lists catalogs in a given space.

Parameters
Name Description
parent std::string const &

Required. The parent space from which catalogs are listed. Format: projects/$project/locations/$location/spaces/$space

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Catalog >

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.designcenter.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCatalogs(google::cloud::designcenter::v1::ListCatalogsRequest, Options)

Lists catalogs in a given space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListCatalogsRequest

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.designcenter.v1.ListCatalogsRequest. 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::designcenter::v1::Catalog >

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.designcenter.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateCatalog(std::string const &, google::cloud::designcenter::v1::Catalog const &, std::string const &, Options)

Creates a catalog.

Parameters
Name Description
parent std::string const &

Required. The parent space in which a catalog is created in the following format: projects/$project/locations/$location/spaces/$space

catalog google::cloud::designcenter::v1::Catalog const &

Required. The catalog to create.

catalog_id std::string const &

Required. The ID of the catalog to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCatalog(google::cloud::designcenter::v1::CreateCatalogRequest const &, Options)

Creates a catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateCatalogRequest 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.designcenter.v1.CreateCatalogRequest. 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::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateCatalog(google::cloud::designcenter::v1::Catalog const &, google::protobuf::FieldMask const &, Options)

Updates a catalog.

Parameters
Name Description
catalog google::cloud::designcenter::v1::Catalog const &

Required. The catalog to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the catalog update. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateCatalog(google::cloud::designcenter::v1::UpdateCatalogRequest const &, Options)

Updates a catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateCatalogRequest 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.designcenter.v1.UpdateCatalogRequest. 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::designcenter::v1::Catalog >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteCatalog(std::string const &, Options)

Deletes a catalog.

Parameters
Name Description
name std::string const &

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalog(NoAwaitTag, std::string const &, Options)

Deletes a catalog.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalog(google::cloud::designcenter::v1::DeleteCatalogRequest const &, Options)

Deletes a catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteCatalogRequest 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.designcenter.v1.DeleteCatalogRequest. 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
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalog(NoAwaitTag, google::cloud::designcenter::v1::DeleteCatalogRequest const &, Options)

Deletes a catalog.

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::designcenter::v1::DeleteCatalogRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalog(google::longrunning::Operation const &, Options)

Deletes a catalog.

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::designcenter::v1::OperationMetadata > >

CreateCatalogTemplate(std::string const &, google::cloud::designcenter::v1::CatalogTemplate const &, std::string const &, Options)

Adds a template to a catalog.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which the catalog template is created.

catalog_template google::cloud::designcenter::v1::CatalogTemplate const &

Required. The catalog template to create.

catalog_template_id std::string const &

Required. The ID of the catalog template to create. The ID is appended to the catalog template's name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCatalogTemplate(google::cloud::designcenter::v1::CreateCatalogTemplateRequest const &, Options)

Adds a template to a catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateCatalogTemplateRequest 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.designcenter.v1.CreateCatalogTemplateRequest. 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::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCatalogTemplate(std::string const &, Options)

Gets a catalog template.

Parameters
Name Description
name std::string const &

Required. The catalog template name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCatalogTemplate(google::cloud::designcenter::v1::GetCatalogTemplateRequest const &, Options)

Gets a catalog template.

Parameters
Name Description
request google::cloud::designcenter::v1::GetCatalogTemplateRequest 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.designcenter.v1.GetCatalogTemplateRequest. 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::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListCatalogTemplates(std::string const &, Options)

Lists catalog templates.

Parameters
Name Description
parent std::string const &

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::CatalogTemplate >

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.designcenter.v1.CatalogTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCatalogTemplates(google::cloud::designcenter::v1::ListCatalogTemplatesRequest, Options)

Lists catalog templates.

Parameters
Name Description
request google::cloud::designcenter::v1::ListCatalogTemplatesRequest

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.designcenter.v1.ListCatalogTemplatesRequest. 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::designcenter::v1::CatalogTemplate >

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.designcenter.v1.CatalogTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateCatalogTemplate(google::cloud::designcenter::v1::CatalogTemplate const &, google::protobuf::FieldMask const &, Options)

Updates a catalog template resource.

Parameters
Name Description
catalog_template google::cloud::designcenter::v1::CatalogTemplate const &

Required. The catalog template to update. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the catalog template update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateCatalogTemplate(google::cloud::designcenter::v1::UpdateCatalogTemplateRequest const &, Options)

Updates a catalog template resource.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateCatalogTemplateRequest 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.designcenter.v1.UpdateCatalogTemplateRequest. 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::designcenter::v1::CatalogTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteCatalogTemplate(std::string const &, Options)

Deletes a catalog template.

Parameters
Name Description
name std::string const &

Required. The catalog template name. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalogTemplate(NoAwaitTag, std::string const &, Options)

Deletes a catalog template.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalogTemplate(google::cloud::designcenter::v1::DeleteCatalogTemplateRequest const &, Options)

Deletes a catalog template.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteCatalogTemplateRequest 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.designcenter.v1.DeleteCatalogTemplateRequest. 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
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalogTemplate(NoAwaitTag, google::cloud::designcenter::v1::DeleteCatalogTemplateRequest const &, Options)

Deletes a catalog template.

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::designcenter::v1::DeleteCatalogTemplateRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalogTemplate(google::longrunning::Operation const &, Options)

Deletes a catalog template.

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::designcenter::v1::OperationMetadata > >

CreateShare(std::string const &, google::cloud::designcenter::v1::Share const &, std::string const &, Options)

Shares a catalog from one space to another space.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which shares are created.

share google::cloud::designcenter::v1::Share const &

Required. The share to create.

share_id std::string const &

Required. The ID of the share to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::Share > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.Share proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateShare(NoAwaitTag, std::string const &, google::cloud::designcenter::v1::Share const &, std::string const &, Options)

Shares a catalog from one space to another space.

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
parent std::string const &
share google::cloud::designcenter::v1::Share const &
share_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateShare(google::cloud::designcenter::v1::CreateShareRequest const &, Options)

Shares a catalog from one space to another space.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateShareRequest 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.designcenter.v1.CreateShareRequest. 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
future< StatusOr< google::cloud::designcenter::v1::Share > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.Share proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateShare(NoAwaitTag, google::cloud::designcenter::v1::CreateShareRequest const &, Options)

Shares a catalog from one space to another space.

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::designcenter::v1::CreateShareRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateShare(google::longrunning::Operation const &, Options)

Shares a catalog from one space to another space.

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::designcenter::v1::Share > >

ListShares(std::string const &, Options)

Lists catalog share objects for the space.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which a list of shares is requested.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Share >

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.designcenter.v1.Share, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListShares(google::cloud::designcenter::v1::ListSharesRequest, Options)

Lists catalog share objects for the space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListSharesRequest

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.designcenter.v1.ListSharesRequest. 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::designcenter::v1::Share >

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.designcenter.v1.Share, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetShare(std::string const &, Options)

Get catalog share object for the space.

Parameters
Name Description
name std::string const &

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Share >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Share) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetShare(google::cloud::designcenter::v1::GetShareRequest const &, Options)

Get catalog share object for the space.

Parameters
Name Description
request google::cloud::designcenter::v1::GetShareRequest 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.designcenter.v1.GetShareRequest. 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::designcenter::v1::Share >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Share) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteShare(std::string const &, Options)

Deletes a catalog share.

Parameters
Name Description
name std::string const &

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteShare(NoAwaitTag, std::string const &, Options)

Deletes a catalog share.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteShare(google::cloud::designcenter::v1::DeleteShareRequest const &, Options)

Deletes a catalog share.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteShareRequest 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.designcenter.v1.DeleteShareRequest. 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
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteShare(NoAwaitTag, google::cloud::designcenter::v1::DeleteShareRequest const &, Options)

Deletes a catalog share.

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::designcenter::v1::DeleteShareRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteShare(google::longrunning::Operation const &, Options)

Deletes a catalog share.

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::designcenter::v1::OperationMetadata > >

SyncShare(std::string const &, Options)

Synchronizes a share and updates the destination workspace to reflect.

reflect the most recent changes to the catalog.

Parameters
Name Description
name std::string const &

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::Share > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.Share proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SyncShare(NoAwaitTag, std::string const &, Options)

Synchronizes a share and updates the destination workspace to reflect.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SyncShare(google::cloud::designcenter::v1::SyncShareRequest const &, Options)

Synchronizes a share and updates the destination workspace to reflect.

reflect the most recent changes to the catalog.

Parameters
Name Description
request google::cloud::designcenter::v1::SyncShareRequest 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.designcenter.v1.SyncShareRequest. 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
future< StatusOr< google::cloud::designcenter::v1::Share > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.Share proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SyncShare(NoAwaitTag, google::cloud::designcenter::v1::SyncShareRequest const &, Options)

Synchronizes a share and updates the destination workspace to reflect.

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::designcenter::v1::SyncShareRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

SyncShare(google::longrunning::Operation const &, Options)

Synchronizes a share and updates the destination workspace to reflect.

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::designcenter::v1::Share > >

GetSharedTemplate(std::string const &, Options)

Gets details about a shared template.

Parameters
Name Description
name std::string const &

Required. The shared template name. Format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::SharedTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.SharedTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSharedTemplate(google::cloud::designcenter::v1::GetSharedTemplateRequest const &, Options)

Gets details about a shared template.

Parameters
Name Description
request google::cloud::designcenter::v1::GetSharedTemplateRequest 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.designcenter.v1.GetSharedTemplateRequest. 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::designcenter::v1::SharedTemplate >

the result of the RPC. The response message type (google.cloud.designcenter.v1.SharedTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSharedTemplates(std::string const &, Options)

Lists shared templates in a given space.

Parameters
Name Description
parent std::string const &

Required. The parent space for which shared templates are listed in the following format: projects/$project/locations/$location/spaces/$space

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::SharedTemplate >

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.designcenter.v1.SharedTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSharedTemplates(google::cloud::designcenter::v1::ListSharedTemplatesRequest, Options)

Lists shared templates in a given space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListSharedTemplatesRequest

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.designcenter.v1.ListSharedTemplatesRequest. 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::designcenter::v1::SharedTemplate >

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.designcenter.v1.SharedTemplate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetSharedTemplateRevision(std::string const &, Options)

Gets details about a shared template revision.

Parameters
Name Description
name std::string const &

Required. The shared template revision name, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate/revisions/$revision

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::SharedTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.SharedTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSharedTemplateRevision(google::cloud::designcenter::v1::GetSharedTemplateRevisionRequest const &, Options)

Gets details about a shared template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::GetSharedTemplateRevisionRequest 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.designcenter.v1.GetSharedTemplateRevisionRequest. 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::designcenter::v1::SharedTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.SharedTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListSharedTemplateRevisions(std::string const &, Options)

Lists shared template revisions in a given space.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which to list shared template revisions, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::SharedTemplateRevision >

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.designcenter.v1.SharedTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSharedTemplateRevisions(google::cloud::designcenter::v1::ListSharedTemplateRevisionsRequest, Options)

Lists shared template revisions in a given space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListSharedTemplateRevisionsRequest

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.designcenter.v1.ListSharedTemplateRevisionsRequest. 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::designcenter::v1::SharedTemplateRevision >

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.designcenter.v1.SharedTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateCatalogTemplateRevision(std::string const &, google::cloud::designcenter::v1::CatalogTemplateRevision const &, std::string const &, Options)

Creates a template revision.

Parameters
Name Description
parent std::string const &

Required. The parent in which the catalog template revisions request is created in following format: projects/$project/locations/$location/spaces/$space/templates/$template

catalog_template_revision google::cloud::designcenter::v1::CatalogTemplateRevision const &

Required. The template revision to create.

catalog_template_revision_id std::string const &

Required. The ID of the template revision to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::CatalogTemplateRevision > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.CatalogTemplateRevision proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCatalogTemplateRevision(NoAwaitTag, std::string const &, google::cloud::designcenter::v1::CatalogTemplateRevision const &, std::string const &, Options)

Creates a template revision.

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
parent std::string const &
catalog_template_revision google::cloud::designcenter::v1::CatalogTemplateRevision const &
catalog_template_revision_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCatalogTemplateRevision(google::cloud::designcenter::v1::CreateCatalogTemplateRevisionRequest const &, Options)

Creates a template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateCatalogTemplateRevisionRequest 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.designcenter.v1.CreateCatalogTemplateRevisionRequest. 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
future< StatusOr< google::cloud::designcenter::v1::CatalogTemplateRevision > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.CatalogTemplateRevision proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCatalogTemplateRevision(NoAwaitTag, google::cloud::designcenter::v1::CreateCatalogTemplateRevisionRequest const &, Options)

Creates a template revision.

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::designcenter::v1::CreateCatalogTemplateRevisionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCatalogTemplateRevision(google::longrunning::Operation const &, Options)

Creates a template revision.

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::designcenter::v1::CatalogTemplateRevision > >

GetCatalogTemplateRevision(std::string const &, Options)

Gets details about a template revision.

Parameters
Name Description
name std::string const &

Required. The catalog template revisions name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::CatalogTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCatalogTemplateRevision(google::cloud::designcenter::v1::GetCatalogTemplateRevisionRequest const &, Options)

Gets details about a template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::GetCatalogTemplateRevisionRequest 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.designcenter.v1.GetCatalogTemplateRevisionRequest. 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::designcenter::v1::CatalogTemplateRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.CatalogTemplateRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListCatalogTemplateRevisions(std::string const &, Options)

Lists template revisions.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which a list of catalog template revisions is requested.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::CatalogTemplateRevision >

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.designcenter.v1.CatalogTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCatalogTemplateRevisions(google::cloud::designcenter::v1::ListCatalogTemplateRevisionsRequest, Options)

Lists template revisions.

Parameters
Name Description
request google::cloud::designcenter::v1::ListCatalogTemplateRevisionsRequest

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.designcenter.v1.ListCatalogTemplateRevisionsRequest. 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::designcenter::v1::CatalogTemplateRevision >

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.designcenter.v1.CatalogTemplateRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteCatalogTemplateRevision(std::string const &, Options)

Deletes a template revision.

Parameters
Name Description
name std::string const &

Required. The template revision name.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalogTemplateRevision(NoAwaitTag, std::string const &, Options)

Deletes a template revision.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalogTemplateRevision(google::cloud::designcenter::v1::DeleteCatalogTemplateRevisionRequest const &, Options)

Deletes a template revision.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteCatalogTemplateRevisionRequest 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.designcenter.v1.DeleteCatalogTemplateRevisionRequest. 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
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCatalogTemplateRevision(NoAwaitTag, google::cloud::designcenter::v1::DeleteCatalogTemplateRevisionRequest const &, Options)

Deletes a template revision.

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::designcenter::v1::DeleteCatalogTemplateRevisionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCatalogTemplateRevision(google::longrunning::Operation const &, Options)

Deletes a template revision.

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::designcenter::v1::OperationMetadata > >

CreateApplication(std::string const &, google::cloud::designcenter::v1::Application const &, std::string const &, Options)

Creates an application.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which to create the application. Format: projects/$project/locations/$location/spaces/$space

application google::cloud::designcenter::v1::Application const &

Required. The application to create.

application_id std::string const &

Required. The ID of the application to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateApplication(google::cloud::designcenter::v1::CreateApplicationRequest const &, Options)

Creates an application.

Parameters
Name Description
request google::cloud::designcenter::v1::CreateApplicationRequest 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.designcenter.v1.CreateApplicationRequest. 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::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplication(std::string const &, Options)

Gets details about an application.

Parameters
Name Description
name std::string const &

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplication(google::cloud::designcenter::v1::GetApplicationRequest const &, Options)

Gets details about an application.

Parameters
Name Description
request google::cloud::designcenter::v1::GetApplicationRequest 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.designcenter.v1.GetApplicationRequest. 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::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListApplications(std::string const &, Options)

Lists applications in a given space.

Parameters
Name Description
parent std::string const &

Required. The parent resource from which to request a list of applications.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Application >

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.designcenter.v1.Application, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListApplications(google::cloud::designcenter::v1::ListApplicationsRequest, Options)

Lists applications in a given space.

Parameters
Name Description
request google::cloud::designcenter::v1::ListApplicationsRequest

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.designcenter.v1.ListApplicationsRequest. 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::designcenter::v1::Application >

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.designcenter.v1.Application, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateApplication(google::cloud::designcenter::v1::Application const &, google::protobuf::FieldMask const &, Options)

Updates an application.

Parameters
Name Description
application google::cloud::designcenter::v1::Application const &

Required. The application to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the application update. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateApplication(google::cloud::designcenter::v1::UpdateApplicationRequest const &, Options)

Updates an application.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdateApplicationRequest 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.designcenter.v1.UpdateApplicationRequest. 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::designcenter::v1::Application >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteApplication(std::string const &, Options)

Deletes an application.

Parameters
Name Description
name std::string const &

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteApplication(NoAwaitTag, std::string const &, Options)

Deletes an application.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteApplication(google::cloud::designcenter::v1::DeleteApplicationRequest const &, Options)

Deletes an application.

Parameters
Name Description
request google::cloud::designcenter::v1::DeleteApplicationRequest 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.designcenter.v1.DeleteApplicationRequest. 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
future< StatusOr< google::cloud::designcenter::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteApplication(NoAwaitTag, google::cloud::designcenter::v1::DeleteApplicationRequest const &, Options)

Deletes an application.

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::designcenter::v1::DeleteApplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteApplication(google::longrunning::Operation const &, Options)

Deletes an application.

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::designcenter::v1::OperationMetadata > >

DeployApplication(std::string const &, Options)

Deploys an application.

Parameters
Name Description
name std::string const &

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::DeployApplicationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.DeployApplicationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeployApplication(NoAwaitTag, std::string const &, Options)

Deploys an application.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeployApplication(google::cloud::designcenter::v1::DeployApplicationRequest const &, Options)

Deploys an application.

Parameters
Name Description
request google::cloud::designcenter::v1::DeployApplicationRequest 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.designcenter.v1.DeployApplicationRequest. 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
future< StatusOr< google::cloud::designcenter::v1::DeployApplicationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.DeployApplicationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeployApplication(NoAwaitTag, google::cloud::designcenter::v1::DeployApplicationRequest const &, Options)

Deploys an application.

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::designcenter::v1::DeployApplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeployApplication(google::longrunning::Operation const &, Options)

Deploys an application.

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::designcenter::v1::DeployApplicationResponse > >

PreviewApplication(std::string const &, Options)

Previews deployment of an application.

Parameters
Name Description
name std::string const &

Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::PreviewApplicationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.PreviewApplicationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewApplication(NoAwaitTag, std::string const &, Options)

Previews deployment of an application.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

PreviewApplication(google::cloud::designcenter::v1::PreviewApplicationRequest const &, Options)

Previews deployment of an application.

Parameters
Name Description
request google::cloud::designcenter::v1::PreviewApplicationRequest 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.designcenter.v1.PreviewApplicationRequest. 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
future< StatusOr< google::cloud::designcenter::v1::PreviewApplicationResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.PreviewApplicationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewApplication(NoAwaitTag, google::cloud::designcenter::v1::PreviewApplicationRequest const &, Options)

Previews deployment of an application.

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::designcenter::v1::PreviewApplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

PreviewApplication(google::longrunning::Operation const &, Options)

Previews deployment of an application.

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::designcenter::v1::PreviewApplicationResponse > >

FetchApplicationAssessmentReport(std::string const &, Options)

Fetches the assessment report of a deployed application if present.

Parameters
Name Description
name std::string const &

Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::FetchApplicationAssessmentReportResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.FetchApplicationAssessmentReportResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

FetchApplicationAssessmentReport(google::cloud::designcenter::v1::FetchApplicationAssessmentReportRequest const &, Options)

Fetches the assessment report of a deployed application if present.

Parameters
Name Description
request google::cloud::designcenter::v1::FetchApplicationAssessmentReportRequest 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.designcenter.v1.FetchApplicationAssessmentReportRequest. 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::designcenter::v1::FetchApplicationAssessmentReportResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.FetchApplicationAssessmentReportResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateApplicationAssessmentReport(std::string const &, Options)

Generate Assessment Reports of an application.

Parameters
Name Description
name std::string const &

Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::GenerateApplicationAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateApplicationAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateApplicationAssessmentReport(NoAwaitTag, std::string const &, Options)

Generate Assessment Reports of an application.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateApplicationAssessmentReport(google::cloud::designcenter::v1::GenerateApplicationAssessmentReportRequest const &, Options)

Generate Assessment Reports of an application.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateApplicationAssessmentReportRequest 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.designcenter.v1.GenerateApplicationAssessmentReportRequest. 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
future< StatusOr< google::cloud::designcenter::v1::GenerateApplicationAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateApplicationAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateApplicationAssessmentReport(NoAwaitTag, google::cloud::designcenter::v1::GenerateApplicationAssessmentReportRequest const &, Options)

Generate Assessment Reports of an application.

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::designcenter::v1::GenerateApplicationAssessmentReportRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateApplicationAssessmentReport(google::longrunning::Operation const &, Options)

Generate Assessment Reports of an application.

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::designcenter::v1::GenerateApplicationAssessmentReportResponse > >

GenerateApplicationTemplateAssessmentReport(std::string const &, Options)

Generate Assessment Reports of an application template.

Parameters
Name Description
name std::string const &

Required. The application template name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::GenerateApplicationTemplateAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateApplicationTemplateAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateApplicationTemplateAssessmentReport(NoAwaitTag, std::string const &, Options)

Generate Assessment Reports of an application template.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateApplicationTemplateAssessmentReport(google::cloud::designcenter::v1::GenerateApplicationTemplateAssessmentReportRequest const &, Options)

Generate Assessment Reports of an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateApplicationTemplateAssessmentReportRequest 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.designcenter.v1.GenerateApplicationTemplateAssessmentReportRequest. 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
future< StatusOr< google::cloud::designcenter::v1::GenerateApplicationTemplateAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateApplicationTemplateAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateApplicationTemplateAssessmentReport(NoAwaitTag, google::cloud::designcenter::v1::GenerateApplicationTemplateAssessmentReportRequest const &, Options)

Generate Assessment Reports of an application template.

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::designcenter::v1::GenerateApplicationTemplateAssessmentReportRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateApplicationTemplateAssessmentReport(google::longrunning::Operation const &, Options)

Generate Assessment Reports of an application template.

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::designcenter::v1::GenerateApplicationTemplateAssessmentReportResponse > >

GenerateAssessmentReport(std::string const &, Options)

Deprecated: Use GenerateTerraformPlanAssessmentReport instead.

Generate a best practice report for a given Terraform plan.

Parameters
Name Description
space_name std::string const &

Required. The name of the space at which Generate Assessment Report is called. Format: projects/$project/locations/$location/spaces/$space

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::GenerateAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateAssessmentReport(NoAwaitTag, std::string const &, Options)

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
space_name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateAssessmentReport(google::cloud::designcenter::v1::GenerateAssessmentReportRequest const &, Options)

Deprecated: Use GenerateTerraformPlanAssessmentReport instead.

Generate a best practice report for a given Terraform plan.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateAssessmentReportRequest 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.designcenter.v1.GenerateAssessmentReportRequest. 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
future< StatusOr< google::cloud::designcenter::v1::GenerateAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateAssessmentReport(NoAwaitTag, google::cloud::designcenter::v1::GenerateAssessmentReportRequest const &, Options)

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::designcenter::v1::GenerateAssessmentReportRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateAssessmentReport(google::longrunning::Operation const &, Options)

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::designcenter::v1::GenerateAssessmentReportResponse > >

GenerateTerraformPlanAssessmentReport(std::string const &, std::string const &, Options)

Generate a Terraform plan assessment report for a given Terraform plan.

Parameters
Name Description
name std::string const &

Required. The parent resource in which to generate the assessment report. Format: projects/$project/locations/$location/spaces/$space

terraform_plan std::string const &

Required. The raw JSON representation of the generated Terraform plan, provided as bytes.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::GenerateTerraformPlanAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateTerraformPlanAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateTerraformPlanAssessmentReport(NoAwaitTag, std::string const &, std::string const &, Options)

Generate a Terraform plan assessment report for a given Terraform plan.

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 &
terraform_plan std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateTerraformPlanAssessmentReport(google::cloud::designcenter::v1::GenerateTerraformPlanAssessmentReportRequest const &, Options)

Generate a Terraform plan assessment report for a given Terraform plan.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateTerraformPlanAssessmentReportRequest 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.designcenter.v1.GenerateTerraformPlanAssessmentReportRequest. 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
future< StatusOr< google::cloud::designcenter::v1::GenerateTerraformPlanAssessmentReportResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.GenerateTerraformPlanAssessmentReportResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GenerateTerraformPlanAssessmentReport(NoAwaitTag, google::cloud::designcenter::v1::GenerateTerraformPlanAssessmentReportRequest const &, Options)

Generate a Terraform plan assessment report for a given Terraform plan.

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::designcenter::v1::GenerateTerraformPlanAssessmentReportRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

GenerateTerraformPlanAssessmentReport(google::longrunning::Operation const &, Options)

Generate a Terraform plan assessment report for a given Terraform plan.

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::designcenter::v1::GenerateTerraformPlanAssessmentReportResponse > >

GetPolicy(std::string const &, Options)

Policy related APIs.

Get a policy for an application template.

Parameters
Name Description
name std::string const &

Required. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPolicy(google::cloud::designcenter::v1::GetPolicyRequest const &, Options)

Policy related APIs.

Get a policy for an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::GetPolicyRequest 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.designcenter.v1.GetPolicyRequest. 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::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListPolicies(std::string const &, Options)

Lists policies for an application template.

Parameters
Name Description
parent std::string const &

Required. The parent application template from which policies are listed in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Policy >

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.designcenter.v1.Policy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPolicies(google::cloud::designcenter::v1::ListPoliciesRequest, Options)

Lists policies for an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ListPoliciesRequest

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.designcenter.v1.ListPoliciesRequest. 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::designcenter::v1::Policy >

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.designcenter.v1.Policy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreatePolicy(std::string const &, google::cloud::designcenter::v1::Policy const &, std::string const &, Options)

Creates a policy for an application template.

Parameters
Name Description
parent std::string const &

Required. The parent resource in which to create the policy in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate

policy google::cloud::designcenter::v1::Policy const &

Required. The policy to create.

policy_id std::string const &

Required. The ID of the policy to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreatePolicy(google::cloud::designcenter::v1::CreatePolicyRequest const &, Options)

Creates a policy for an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::CreatePolicyRequest 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.designcenter.v1.CreatePolicyRequest. 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::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdatePolicy(google::cloud::designcenter::v1::Policy const &, google::protobuf::FieldMask const &, Options)

Updates a policy.

Parameters
Name Description
policy google::cloud::designcenter::v1::Policy const &

Required. The policy to update.

update_mask google::protobuf::FieldMask const &

Optional. The fields to overwrite in the policy update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdatePolicy(google::cloud::designcenter::v1::UpdatePolicyRequest const &, Options)

Updates a policy.

Parameters
Name Description
request google::cloud::designcenter::v1::UpdatePolicyRequest 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.designcenter.v1.UpdatePolicyRequest. 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::designcenter::v1::Policy >

the result of the RPC. The response message type (google.cloud.designcenter.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeletePolicy(std::string const &, Options)

Deletes a policy.

Parameters
Name Description
name std::string const &

Required. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy

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.

DeletePolicy(google::cloud::designcenter::v1::DeletePolicyRequest const &, Options)

Deletes a policy.

Parameters
Name Description
request google::cloud::designcenter::v1::DeletePolicyRequest 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.designcenter.v1.DeletePolicyRequest. 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.

FetchFrameworks(std::string const &, Options)

Fetches all frameworks for assessment report.

Parameters
Name Description
parent std::string const &

Required. The parent resource name. Format: projects/{project}/locations/{location}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::Framework >

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.designcenter.v1.Framework, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

FetchFrameworks(google::cloud::designcenter::v1::FetchFrameworksRequest, Options)

Fetches all frameworks for assessment report.

Parameters
Name Description
request google::cloud::designcenter::v1::FetchFrameworksRequest

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.designcenter.v1.FetchFrameworksRequest. 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::designcenter::v1::Framework >

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.designcenter.v1.Framework, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GenerateApplicationIaC(std::string const &, Options)

Generates Terraform files for an application.

Parameters
Name Description
name std::string const &

Required. The name of the application.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::GenerateApplicationIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateApplicationIaC(google::cloud::designcenter::v1::GenerateApplicationIaCRequest const &, Options)

Generates Terraform files for an application.

Parameters
Name Description
request google::cloud::designcenter::v1::GenerateApplicationIaCRequest 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.designcenter.v1.GenerateApplicationIaCRequest. 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::designcenter::v1::GenerateApplicationIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.GenerateApplicationIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ExportApplicationIaC(std::string const &, Options)

Exports Terraform files for an application asynchronously.

Parameters
Name Description
name std::string const &

Required. The name of the application.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationIaC(NoAwaitTag, std::string const &, Options)

Exports Terraform files for an application asynchronously.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationIaC(google::cloud::designcenter::v1::ExportApplicationIaCRequest const &, Options)

Exports Terraform files for an application asynchronously.

Parameters
Name Description
request google::cloud::designcenter::v1::ExportApplicationIaCRequest 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.designcenter.v1.ExportApplicationIaCRequest. 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
future< StatusOr< google::cloud::designcenter::v1::ExportApplicationIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.ExportApplicationIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportApplicationIaC(NoAwaitTag, google::cloud::designcenter::v1::ExportApplicationIaCRequest const &, Options)

Exports Terraform files for an application asynchronously.

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::designcenter::v1::ExportApplicationIaCRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportApplicationIaC(google::longrunning::Operation const &, Options)

Exports Terraform files for an application asynchronously.

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::designcenter::v1::ExportApplicationIaCResponse > >

ImportApplicationTemplateIaC(std::string const &, Options)

Imports IaC for an application template.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ImportApplicationTemplateIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ImportApplicationTemplateIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportApplicationTemplateIaC(google::cloud::designcenter::v1::ImportApplicationTemplateIaCRequest const &, Options)

Imports IaC for an application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ImportApplicationTemplateIaCRequest 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.designcenter.v1.ImportApplicationTemplateIaCRequest. 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::designcenter::v1::ImportApplicationTemplateIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ImportApplicationTemplateIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

IngestApplicationTemplateIaC(std::string const &, Options)

Ingests IaC for an application template asynchronously.

Parameters
Name Description
name std::string const &

Required. The name of the application template.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::IngestApplicationTemplateIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.IngestApplicationTemplateIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

IngestApplicationTemplateIaC(NoAwaitTag, std::string const &, Options)

Ingests IaC for an application template asynchronously.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

IngestApplicationTemplateIaC(google::cloud::designcenter::v1::IngestApplicationTemplateIaCRequest const &, Options)

Ingests IaC for an application template asynchronously.

Parameters
Name Description
request google::cloud::designcenter::v1::IngestApplicationTemplateIaCRequest 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.designcenter.v1.IngestApplicationTemplateIaCRequest. 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
future< StatusOr< google::cloud::designcenter::v1::IngestApplicationTemplateIaCResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.IngestApplicationTemplateIaCResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

IngestApplicationTemplateIaC(NoAwaitTag, google::cloud::designcenter::v1::IngestApplicationTemplateIaCRequest const &, Options)

Ingests IaC for an application template asynchronously.

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::designcenter::v1::IngestApplicationTemplateIaCRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

IngestApplicationTemplateIaC(google::longrunning::Operation const &, Options)

Ingests IaC for an application template asynchronously.

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::designcenter::v1::IngestApplicationTemplateIaCResponse > >

ImportApplicationIaC(std::string const &, Options)

Imports IaC for an application resource.

Parameters
Name Description
name std::string const &

Required. The name of the application.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ImportApplicationIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ImportApplicationIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportApplicationIaC(google::cloud::designcenter::v1::ImportApplicationIaCRequest const &, Options)

Imports IaC for an application resource.

Parameters
Name Description
request google::cloud::designcenter::v1::ImportApplicationIaCRequest 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.designcenter.v1.ImportApplicationIaCRequest. 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::designcenter::v1::ImportApplicationIaCResponse >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ImportApplicationIaCResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RegisterAppHubApplicationResources(std::string const &, std::string const &, std::string const &, Options)

Register deployed resources from terraform state file with App Hub without needing a space.

Parameters
Name Description
parent std::string const &

Required. The parent location. Format: projects/{project}/locations/{location}

apphub_application std::string const &

Required. The name of the AppHub Application. Format: projects/{project}/locations/{location}/applications/{application}

tfstate_content std::string const &

Optional. The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::RegisterAppHubApplicationResourcesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.RegisterAppHubApplicationResourcesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RegisterAppHubApplicationResources(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)

Register deployed resources from terraform state file with App Hub without needing a space.

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
parent std::string const &
apphub_application std::string const &
tfstate_content std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RegisterAppHubApplicationResources(google::cloud::designcenter::v1::RegisterAppHubApplicationResourcesRequest const &, Options)

Register deployed resources from terraform state file with App Hub without needing a space.

Parameters
Name Description
request google::cloud::designcenter::v1::RegisterAppHubApplicationResourcesRequest 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.designcenter.v1.RegisterAppHubApplicationResourcesRequest. 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
future< StatusOr< google::cloud::designcenter::v1::RegisterAppHubApplicationResourcesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.RegisterAppHubApplicationResourcesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RegisterAppHubApplicationResources(NoAwaitTag, google::cloud::designcenter::v1::RegisterAppHubApplicationResourcesRequest const &, Options)

Register deployed resources from terraform state file with App Hub without needing a space.

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::designcenter::v1::RegisterAppHubApplicationResourcesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RegisterAppHubApplicationResources(google::longrunning::Operation const &, Options)

Register deployed resources from terraform state file with App Hub without needing a space.

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::designcenter::v1::RegisterAppHubApplicationResourcesResponse > >

ListApplicationTemplateSystemRevisions(std::string const &, Options)

Lists application template system revisions in a given application template.

Parameters
Name Description
parent std::string const &

Required. The parent Application Template from which to list the system revisions. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::designcenter::v1::ApplicationTemplateSystemRevision >

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.designcenter.v1.ApplicationTemplateSystemRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListApplicationTemplateSystemRevisions(google::cloud::designcenter::v1::ListApplicationTemplateSystemRevisionsRequest, Options)

Lists application template system revisions in a given application template.

Parameters
Name Description
request google::cloud::designcenter::v1::ListApplicationTemplateSystemRevisionsRequest

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.designcenter.v1.ListApplicationTemplateSystemRevisionsRequest. 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::designcenter::v1::ApplicationTemplateSystemRevision >

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.designcenter.v1.ApplicationTemplateSystemRevision, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetApplicationTemplateSystemRevision(std::string const &, Options)

Gets the given application template system revision.

Parameters
Name Description
name std::string const &

Required. The name of the ApplicationTemplateSystemRevision to retrieve. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/systemRevisions/{system_revision}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::designcenter::v1::ApplicationTemplateSystemRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateSystemRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetApplicationTemplateSystemRevision(google::cloud::designcenter::v1::GetApplicationTemplateSystemRevisionRequest const &, Options)

Gets the given application template system revision.

Parameters
Name Description
request google::cloud::designcenter::v1::GetApplicationTemplateSystemRevisionRequest 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.designcenter.v1.GetApplicationTemplateSystemRevisionRequest. 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::designcenter::v1::ApplicationTemplateSystemRevision >

the result of the RPC. The response message type (google.cloud.designcenter.v1.ApplicationTemplateSystemRevision) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RecommendIAMRoles(std::string const &, Options)

Gets recommended IAM roles for an application.

Evaluates the infrastructure resources defined by an application (including its template configuration and parameters) to determine the set of IAM roles and Google Cloud APIs that you must configure before you deploy across target projects.

The operation is asynchronous and returns a google.longrunning.Operation. Upon completion, the operation result contains a RecommendIAMRolesResponse with project-level IAM role and API recommendations.

Parameters
Name Description
name std::string const &

Required. The name of the application resource for which to recommend IAM roles. Format: projects/$project/locations/$location/spaces/$space/applications/$application

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::designcenter::v1::RecommendIAMRolesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.RecommendIAMRolesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RecommendIAMRoles(NoAwaitTag, std::string const &, Options)

Gets recommended IAM roles for an application.

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 &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RecommendIAMRoles(google::cloud::designcenter::v1::RecommendIAMRolesRequest const &, Options)

Gets recommended IAM roles for an application.

Evaluates the infrastructure resources defined by an application (including its template configuration and parameters) to determine the set of IAM roles and Google Cloud APIs that you must configure before you deploy across target projects.

The operation is asynchronous and returns a google.longrunning.Operation. Upon completion, the operation result contains a RecommendIAMRolesResponse with project-level IAM role and API recommendations.

Parameters
Name Description
request google::cloud::designcenter::v1::RecommendIAMRolesRequest 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.designcenter.v1.RecommendIAMRolesRequest. 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
future< StatusOr< google::cloud::designcenter::v1::RecommendIAMRolesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.designcenter.v1.RecommendIAMRolesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RecommendIAMRoles(NoAwaitTag, google::cloud::designcenter::v1::RecommendIAMRolesRequest const &, Options)

Gets recommended IAM roles for an application.

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::designcenter::v1::RecommendIAMRolesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RecommendIAMRoles(google::longrunning::Operation const &, Options)

Gets recommended IAM roles for an application.

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::designcenter::v1::RecommendIAMRolesResponse > >

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.

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 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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. 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::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 StatusOr contains the error details.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. 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.

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

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. 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.