The App Hub API allows you to manage App Hub 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
AppHubClient(AppHubClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppHubClient const &
|
AppHubClient(AppHubClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppHubClient &&
|
AppHubClient(std::shared_ptr< AppHubConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< AppHubConnection >
|
opts |
Options
|
Operators
operator=(AppHubClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppHubClient const &
|
Returns | |
---|---|
Type | Description |
AppHubClient & |
operator=(AppHubClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
AppHubClient &&
|
Returns | |
---|---|
Type | Description |
AppHubClient & |
Functions
LookupServiceProjectAttachment(std::string const &, Options)
Lists a service project attachment for a given service project.
You can call this API from any project to find if it is attached to a host project.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupServiceProjectAttachmentResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupServiceProjectAttachmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupServiceProjectAttachment(google::cloud::apphub::v1::LookupServiceProjectAttachmentRequest const &, Options)
Lists a service project attachment for a given service project.
You can call this API from any project to find if it is attached to a host project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::LookupServiceProjectAttachmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupServiceProjectAttachmentResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupServiceProjectAttachmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListServiceProjectAttachments(std::string const &, Options)
Lists service projects attached to the host project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::ServiceProjectAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServiceProjectAttachments(google::cloud::apphub::v1::ListServiceProjectAttachmentsRequest, Options)
Lists service projects attached to the host project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListServiceProjectAttachmentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::ServiceProjectAttachment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateServiceProjectAttachment(std::string const &, google::cloud::apphub::v1::ServiceProjectAttachment const &, std::string const &, Options)
Attaches a service project to the host project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: |
service_project_attachment |
google::cloud::apphub::v1::ServiceProjectAttachment const &
Required. The resource being created. |
service_project_attachment_id |
std::string const &
Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::ServiceProjectAttachment > > |
A |
CreateServiceProjectAttachment(NoAwaitTag, std::string const &, google::cloud::apphub::v1::ServiceProjectAttachment const &, std::string const &, Options)
Attaches a service project to the host project.
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 &
|
service_project_attachment |
google::cloud::apphub::v1::ServiceProjectAttachment const &
|
service_project_attachment_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateServiceProjectAttachment(google::cloud::apphub::v1::CreateServiceProjectAttachmentRequest const &, Options)
Attaches a service project to the host project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::CreateServiceProjectAttachmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::ServiceProjectAttachment > > |
A |
CreateServiceProjectAttachment(NoAwaitTag, google::cloud::apphub::v1::CreateServiceProjectAttachmentRequest const &, Options)
Attaches a service project to the host project.
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::apphub::v1::CreateServiceProjectAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateServiceProjectAttachment(google::longrunning::Operation const &, Options)
Attaches a service project to the host project.
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::apphub::v1::ServiceProjectAttachment > > |
GetServiceProjectAttachment(std::string const &, Options)
Gets a service project attachment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the service project attachment to retrieve. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::ServiceProjectAttachment > |
the result of the RPC. The response message type (google.cloud.apphub.v1.ServiceProjectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetServiceProjectAttachment(google::cloud::apphub::v1::GetServiceProjectAttachmentRequest const &, Options)
Gets a service project attachment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetServiceProjectAttachmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::ServiceProjectAttachment > |
the result of the RPC. The response message type (google.cloud.apphub.v1.ServiceProjectAttachment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteServiceProjectAttachment(std::string const &, Options)
Deletes a service project attachment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the service project attachment to delete. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteServiceProjectAttachment(NoAwaitTag, std::string const &, Options)
Deletes a service project attachment.
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 > |
DeleteServiceProjectAttachment(google::cloud::apphub::v1::DeleteServiceProjectAttachmentRequest const &, Options)
Deletes a service project attachment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::DeleteServiceProjectAttachmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteServiceProjectAttachment(NoAwaitTag, google::cloud::apphub::v1::DeleteServiceProjectAttachmentRequest const &, Options)
Deletes a service project attachment.
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::apphub::v1::DeleteServiceProjectAttachmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteServiceProjectAttachment(google::longrunning::Operation const &, Options)
Deletes a service project attachment.
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::apphub::v1::OperationMetadata > > |
DetachServiceProjectAttachment(std::string const &, Options)
Detaches a service project from a host project.
You can call this API from any service project without needing access to the host project that it is attached to.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DetachServiceProjectAttachmentResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DetachServiceProjectAttachmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DetachServiceProjectAttachment(google::cloud::apphub::v1::DetachServiceProjectAttachmentRequest const &, Options)
Detaches a service project from a host project.
You can call this API from any service project without needing access to the host project that it is attached to.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::DetachServiceProjectAttachmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DetachServiceProjectAttachmentResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DetachServiceProjectAttachmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListDiscoveredServices(std::string const &, Options)
Lists Discovered Services that can be added to an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Project and location to list Discovered Services on. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::DiscoveredService > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDiscoveredServices(google::cloud::apphub::v1::ListDiscoveredServicesRequest, Options)
Lists Discovered Services that can be added to an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListDiscoveredServicesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::DiscoveredService > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetDiscoveredService(std::string const &, Options)
Gets a Discovered Service in a host project and location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Discovered Service to fetch. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DiscoveredService > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DiscoveredService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDiscoveredService(google::cloud::apphub::v1::GetDiscoveredServiceRequest const &, Options)
Gets a Discovered Service in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetDiscoveredServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DiscoveredService > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DiscoveredService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupDiscoveredService(std::string const &, std::string const &, Options)
Lists a Discovered Service in a host project and location, with a given resource URI.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Host project ID and location to lookup Discovered Service in. Expected format: |
uri |
std::string const &
Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupDiscoveredServiceResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupDiscoveredServiceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupDiscoveredService(google::cloud::apphub::v1::LookupDiscoveredServiceRequest const &, Options)
Lists a Discovered Service in a host project and location, with a given resource URI.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::LookupDiscoveredServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupDiscoveredServiceResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupDiscoveredServiceResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListServices(std::string const &, Options)
Lists Services in an Application.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Fully qualified name of the parent Application to list Services for. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServices(google::cloud::apphub::v1::ListServicesRequest, Options)
Lists Services in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListServicesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateService(std::string const &, google::cloud::apphub::v1::Service const &, std::string const &, Options)
Creates a Service in an Application.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Fully qualified name of the parent Application to create the Service in. Expected format: |
service |
google::cloud::apphub::v1::Service const &
Required. The resource being created. |
service_id |
std::string const &
Required. The Service identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Service > > |
A |
CreateService(NoAwaitTag, std::string const &, google::cloud::apphub::v1::Service const &, std::string const &, Options)
Creates a Service in 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
|
parent |
std::string const &
|
service |
google::cloud::apphub::v1::Service const &
|
service_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateService(google::cloud::apphub::v1::CreateServiceRequest const &, Options)
Creates a Service in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::CreateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Service > > |
A |
CreateService(NoAwaitTag, google::cloud::apphub::v1::CreateServiceRequest const &, Options)
Creates a Service in 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::apphub::v1::CreateServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateService(google::longrunning::Operation const &, Options)
Creates a Service in 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::apphub::v1::Service > > |
GetService(std::string const &, Options)
Gets a Service in an Application.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Service to fetch. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Service > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetService(google::cloud::apphub::v1::GetServiceRequest const &, Options)
Gets a Service in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Service > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateService(google::cloud::apphub::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates a Service in an Application.
Parameters | |
---|---|
Name | Description |
service |
google::cloud::apphub::v1::Service const &
Required. The resource being updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::apphub::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates a Service in 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
|
service |
google::cloud::apphub::v1::Service const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateService(google::cloud::apphub::v1::UpdateServiceRequest const &, Options)
Updates a Service in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::UpdateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::apphub::v1::UpdateServiceRequest const &, Options)
Updates a Service in 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::apphub::v1::UpdateServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateService(google::longrunning::Operation const &, Options)
Updates a Service in 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::apphub::v1::Service > > |
DeleteService(std::string const &, Options)
Deletes a Service from an Application.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Service to delete from an Application. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, std::string const &, Options)
Deletes a Service from 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 > |
DeleteService(google::cloud::apphub::v1::DeleteServiceRequest const &, Options)
Deletes a Service from an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::DeleteServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, google::cloud::apphub::v1::DeleteServiceRequest const &, Options)
Deletes a Service from 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::apphub::v1::DeleteServiceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteService(google::longrunning::Operation const &, Options)
Deletes a Service from 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::apphub::v1::OperationMetadata > > |
ListDiscoveredWorkloads(std::string const &, Options)
Lists Discovered Workloads that can be added to an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Project and location to list Discovered Workloads on. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::DiscoveredWorkload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDiscoveredWorkloads(google::cloud::apphub::v1::ListDiscoveredWorkloadsRequest, Options)
Lists Discovered Workloads that can be added to an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListDiscoveredWorkloadsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::DiscoveredWorkload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetDiscoveredWorkload(std::string const &, Options)
Gets a Discovered Workload in a host project and location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Discovered Workload to fetch. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DiscoveredWorkload > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DiscoveredWorkload) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDiscoveredWorkload(google::cloud::apphub::v1::GetDiscoveredWorkloadRequest const &, Options)
Gets a Discovered Workload in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetDiscoveredWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::DiscoveredWorkload > |
the result of the RPC. The response message type (google.cloud.apphub.v1.DiscoveredWorkload) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupDiscoveredWorkload(std::string const &, std::string const &, Options)
Lists a Discovered Workload in a host project and location, with a given resource URI.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Host project ID and location to lookup Discovered Workload in. Expected format: |
uri |
std::string const &
Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupDiscoveredWorkloadResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupDiscoveredWorkloadResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LookupDiscoveredWorkload(google::cloud::apphub::v1::LookupDiscoveredWorkloadRequest const &, Options)
Lists a Discovered Workload in a host project and location, with a given resource URI.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::LookupDiscoveredWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::LookupDiscoveredWorkloadResponse > |
the result of the RPC. The response message type (google.cloud.apphub.v1.LookupDiscoveredWorkloadResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkloads(std::string const &, Options)
Lists Workloads in an Application.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Fully qualified name of the parent Application to list Workloads for. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Workload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkloads(google::cloud::apphub::v1::ListWorkloadsRequest, Options)
Lists Workloads in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListWorkloadsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Workload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateWorkload(std::string const &, google::cloud::apphub::v1::Workload const &, std::string const &, Options)
Creates a Workload in an Application.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Fully qualified name of the Application to create Workload in. Expected format: |
workload |
google::cloud::apphub::v1::Workload const &
Required. The resource being created. |
workload_id |
std::string const &
Required. The Workload identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Workload > > |
A |
CreateWorkload(NoAwaitTag, std::string const &, google::cloud::apphub::v1::Workload const &, std::string const &, Options)
Creates a Workload in 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
|
parent |
std::string const &
|
workload |
google::cloud::apphub::v1::Workload const &
|
workload_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateWorkload(google::cloud::apphub::v1::CreateWorkloadRequest const &, Options)
Creates a Workload in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::CreateWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Workload > > |
A |
CreateWorkload(NoAwaitTag, google::cloud::apphub::v1::CreateWorkloadRequest const &, Options)
Creates a Workload in 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::apphub::v1::CreateWorkloadRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateWorkload(google::longrunning::Operation const &, Options)
Creates a Workload in 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::apphub::v1::Workload > > |
GetWorkload(std::string const &, Options)
Gets a Workload in an Application.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Workload to fetch. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Workload > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Workload) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkload(google::cloud::apphub::v1::GetWorkloadRequest const &, Options)
Gets a Workload in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Workload > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Workload) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateWorkload(google::cloud::apphub::v1::Workload const &, google::protobuf::FieldMask const &, Options)
Updates a Workload in an Application.
Parameters | |
---|---|
Name | Description |
workload |
google::cloud::apphub::v1::Workload const &
Required. The resource being updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Workload > > |
A |
UpdateWorkload(NoAwaitTag, google::cloud::apphub::v1::Workload const &, google::protobuf::FieldMask const &, Options)
Updates a Workload in 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
|
workload |
google::cloud::apphub::v1::Workload const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateWorkload(google::cloud::apphub::v1::UpdateWorkloadRequest const &, Options)
Updates a Workload in an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::UpdateWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Workload > > |
A |
UpdateWorkload(NoAwaitTag, google::cloud::apphub::v1::UpdateWorkloadRequest const &, Options)
Updates a Workload in 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::apphub::v1::UpdateWorkloadRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateWorkload(google::longrunning::Operation const &, Options)
Updates a Workload in 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::apphub::v1::Workload > > |
DeleteWorkload(std::string const &, Options)
Deletes a Workload from an Application.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Workload to delete from an Application. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteWorkload(NoAwaitTag, std::string const &, Options)
Deletes a Workload from 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 > |
DeleteWorkload(google::cloud::apphub::v1::DeleteWorkloadRequest const &, Options)
Deletes a Workload from an Application.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::DeleteWorkloadRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteWorkload(NoAwaitTag, google::cloud::apphub::v1::DeleteWorkloadRequest const &, Options)
Deletes a Workload from 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::apphub::v1::DeleteWorkloadRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteWorkload(google::longrunning::Operation const &, Options)
Deletes a Workload from 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::apphub::v1::OperationMetadata > > |
ListApplications(std::string const &, Options)
Lists Applications in a host project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Project and location to list Applications on. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Application > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListApplications(google::cloud::apphub::v1::ListApplicationsRequest, Options)
Lists Applications in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::ListApplicationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::apphub::v1::Application > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateApplication(std::string const &, google::cloud::apphub::v1::Application const &, std::string const &, Options)
Creates an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Project and location to create Application in. Expected format: |
application |
google::cloud::apphub::v1::Application const &
Required. The resource being created |
application_id |
std::string const &
Required. The Application identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
A |
CreateApplication(NoAwaitTag, std::string const &, google::cloud::apphub::v1::Application const &, std::string const &, Options)
Creates an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
application |
google::cloud::apphub::v1::Application const &
|
application_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateApplication(google::cloud::apphub::v1::CreateApplicationRequest const &, Options)
Creates an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::CreateApplicationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
A |
CreateApplication(NoAwaitTag, google::cloud::apphub::v1::CreateApplicationRequest const &, Options)
Creates an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::apphub::v1::CreateApplicationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateApplication(google::longrunning::Operation const &, Options)
Creates an Application in a host project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
GetApplication(std::string const &, Options)
Gets an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Application to fetch. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Application > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetApplication(google::cloud::apphub::v1::GetApplicationRequest const &, Options)
Gets an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::GetApplicationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::apphub::v1::Application > |
the result of the RPC. The response message type (google.cloud.apphub.v1.Application) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateApplication(google::cloud::apphub::v1::Application const &, google::protobuf::FieldMask const &, Options)
Updates an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
application |
google::cloud::apphub::v1::Application const &
Required. The resource being updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
A |
UpdateApplication(NoAwaitTag, google::cloud::apphub::v1::Application const &, google::protobuf::FieldMask const &, Options)
Updates an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
application |
google::cloud::apphub::v1::Application const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateApplication(google::cloud::apphub::v1::UpdateApplicationRequest const &, Options)
Updates an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::UpdateApplicationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
A |
UpdateApplication(NoAwaitTag, google::cloud::apphub::v1::UpdateApplicationRequest const &, Options)
Updates an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::apphub::v1::UpdateApplicationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateApplication(google::longrunning::Operation const &, Options)
Updates an Application in a host project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::Application > > |
DeleteApplication(std::string const &, Options)
Deletes an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Fully qualified name of the Application to delete. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteApplication(NoAwaitTag, std::string const &, Options)
Deletes an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteApplication(google::cloud::apphub::v1::DeleteApplicationRequest const &, Options)
Deletes an Application in a host project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::apphub::v1::DeleteApplicationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
A |
DeleteApplication(NoAwaitTag, google::cloud::apphub::v1::DeleteApplicationRequest const &, Options)
Deletes an Application in a host project and location.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::apphub::v1::DeleteApplicationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteApplication(google::longrunning::Operation const &, Options)
Deletes an Application in a host project and location.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::apphub::v1::OperationMetadata > > |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |