Index
AppHub
(interface)Application
(message)Application.State
(enum)Attributes
(message)Channel
(message)ContactInfo
(message)CreateApplicationRequest
(message)CreateServiceProjectAttachmentRequest
(message)CreateServiceRequest
(message)CreateWorkloadRequest
(message)Criticality
(message)Criticality.Type
(enum)DeleteApplicationRequest
(message)DeleteServiceProjectAttachmentRequest
(message)DeleteServiceRequest
(message)DeleteWorkloadRequest
(message)DetachServiceProjectAttachmentRequest
(message)DetachServiceProjectAttachmentResponse
(message)DiscoveredService
(message)DiscoveredWorkload
(message)Environment
(message)Environment.Type
(enum)FindUnregisteredServicesRequest
(message)FindUnregisteredServicesResponse
(message)FindUnregisteredWorkloadsRequest
(message)FindUnregisteredWorkloadsResponse
(message)GetApplicationRequest
(message)GetDiscoveredServiceRequest
(message)GetDiscoveredWorkloadRequest
(message)GetServiceProjectAttachmentRequest
(message)GetServiceRequest
(message)GetWorkloadRequest
(message)ListApplicationsRequest
(message)ListApplicationsResponse
(message)ListDiscoveredServicesRequest
(message)ListDiscoveredServicesResponse
(message)ListDiscoveredWorkloadsRequest
(message)ListDiscoveredWorkloadsResponse
(message)ListServiceProjectAttachmentsRequest
(message)ListServiceProjectAttachmentsResponse
(message)ListServicesRequest
(message)ListServicesResponse
(message)ListWorkloadsRequest
(message)ListWorkloadsResponse
(message)LookupDiscoveredServiceRequest
(message)LookupDiscoveredServiceResponse
(message)LookupDiscoveredWorkloadRequest
(message)LookupDiscoveredWorkloadResponse
(message)LookupServiceProjectAttachmentRequest
(message)LookupServiceProjectAttachmentResponse
(message)OperationMetadata
(message)Scope
(message)Scope.Type
(enum)Service
(message)Service.State
(enum)ServiceProjectAttachment
(message)ServiceProjectAttachment.State
(enum)ServiceProperties
(message)ServiceReference
(message)UpdateApplicationRequest
(message)UpdateServiceRequest
(message)UpdateWorkloadRequest
(message)Workload
(message)Workload.State
(enum)WorkloadProperties
(message)WorkloadReference
(message)
AppHub
The App Hub API allows you to manage App Hub resources.
CreateApplication |
---|
Creates an Application in a host project and location.
|
CreateService |
---|
Creates a Service in an Application.
|
CreateServiceProjectAttachment |
---|
Attaches a service project to the host project.
|
CreateWorkload |
---|
Creates a Workload in an Application.
|
DeleteApplication |
---|
Deletes an Application in a host project and location.
|
DeleteService |
---|
Deletes a Service from an Application.
|
DeleteServiceProjectAttachment |
---|
Deletes a service project attachment.
|
DeleteWorkload |
---|
Deletes a Workload from an Application.
|
DetachServiceProjectAttachment |
---|
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.
|
FindUnregisteredServices |
---|
Finds unregistered services in a host project and location.
|
FindUnregisteredWorkloads |
---|
Finds unregistered workloads in a host project and location.
|
GetApplication |
---|
Gets an Application in a host project and location.
|
GetDiscoveredService |
---|
Gets a Discovered Service in a host project and location.
|
GetDiscoveredWorkload |
---|
Gets a Discovered Workload in a host project and location.
|
GetService |
---|
Gets a Service in an Application.
|
GetServiceProjectAttachment |
---|
Gets a service project attachment.
|
GetWorkload |
---|
Gets a Workload in an Application.
|
ListApplications |
---|
Lists Applications in a host project and location.
|
ListDiscoveredServices |
---|
Lists Discovered Services that can be added to an Application in a host project and location.
|
ListDiscoveredWorkloads |
---|
Lists Discovered Workloads that can be added to an Application in a host project and location.
|
ListServiceProjectAttachments |
---|
Lists service projects attached to the host project.
|
ListServices |
---|
Lists Services in an Application.
|
ListWorkloads |
---|
Lists Workloads in an Application.
|
LookupDiscoveredService |
---|
Lists a Discovered Service in a host project and location, with a given resource URI.
|
LookupDiscoveredWorkload |
---|
Lists a Discovered Workload in a host project and location, with a given resource URI.
|
LookupServiceProjectAttachment |
---|
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.
|
UpdateApplication |
---|
Updates an Application in a host project and location.
|
UpdateService |
---|
Updates a Service in an Application.
|
UpdateWorkload |
---|
Updates a Workload in an Application.
|
Application
Application defines the governance boundary for App Hub entities that perform a logical end-to-end business function. App Hub supports application level IAM permission to align with governance requirements.
Fields | |
---|---|
name |
Identifier. The resource name of an Application. Format: |
display_ |
Optional. User-defined name for the Application. Can have a maximum length of 63 characters. |
description |
Optional. User-defined description of an Application. Can have a maximum length of 2048 characters. |
attributes |
Optional. Consumer provided attributes. |
create_ |
Output only. Create time. |
update_ |
Output only. Update time. |
scope |
Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered. |
uid |
Output only. A universally unique identifier (in UUID4 format) for the |
state |
Output only. Application state. |
State
Application state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
CREATING |
The Application is being created. |
ACTIVE |
The Application is ready to register Services and Workloads. |
DELETING |
The Application is being deleted. |
Attributes
Consumer provided attributes.
Fields | |
---|---|
criticality |
Optional. User-defined criticality information. |
environment |
Optional. User-defined environment information. |
developer_ |
Optional. Developer team that owns development and coding. |
operator_ |
Optional. Operator team that ensures runtime and operations. |
business_ |
Optional. Business team that ensures user needs are met and value is delivered |
Channel
Separate message to accommodate custom formats across IRC and Slack.
Fields | |
---|---|
uri |
Required. URI of the channel. |
ContactInfo
Contact information of stakeholders.
Fields | |
---|---|
display_ |
Optional. Contact's name. Can have a maximum length of 63 characters. |
email |
Required. Email address of the contacts. |
channel |
Optional. Communication channel of the contacts. |
CreateApplicationRequest
Request for CreateApplication.
Fields | |
---|---|
parent |
Required. Project and location to create Application in. Expected format: |
application_ |
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. |
application |
Required. The resource being created |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateServiceProjectAttachmentRequest
Request for CreateServiceProjectAttachment.
Fields | |
---|---|
parent |
Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: |
service_ |
Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field. |
service_ |
Required. The resource being created. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateServiceRequest
Request for CreateService.
Fields | |
---|---|
parent |
Required. Fully qualified name of the parent Application to create the Service in. Expected format: |
service_ |
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. |
service |
Required. The resource being created. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateWorkloadRequest
Request for CreateWorkload.
Fields | |
---|---|
parent |
Required. Fully qualified name of the Application to create Workload in. Expected format: |
workload_ |
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. |
workload |
Required. The resource being created. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
Criticality
Criticality of the Application, Service, or Workload
Fields | |
---|---|
level |
Optional. Criticality level. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead. |
mission_critical |
Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead. |
type |
Required. Criticality Type. |
Type
Criticality Type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified type. |
MISSION_CRITICAL |
Mission critical service, application or workload. |
HIGH |
High impact. |
MEDIUM |
Medium impact. |
LOW |
Low impact. |
DeleteApplicationRequest
Request for DeleteApplication.
Fields | |
---|---|
name |
Required. Fully qualified name of the Application to delete. Expected format: |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteServiceProjectAttachmentRequest
Request for DeleteServiceProjectAttachment.
Fields | |
---|---|
name |
Required. Fully qualified name of the service project attachment to delete. Expected format: |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteServiceRequest
Request for DeleteService.
Fields | |
---|---|
name |
Required. Fully qualified name of the Service to delete from an Application. Expected format: |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteWorkloadRequest
Request for DeleteWorkload.
Fields | |
---|---|
name |
Required. Fully qualified name of the Workload to delete from an Application. Expected format: |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DetachServiceProjectAttachmentRequest
Request for DetachServiceProjectAttachment.
Fields | |
---|---|
name |
Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: |
DetachServiceProjectAttachmentResponse
This type has no fields.
Response for DetachServiceProjectAttachment.
DiscoveredService
DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
Fields | |
---|---|
name |
Identifier. The resource name of the discovered service. Format: |
service_ |
Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable. |
service_ |
Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable. |
DiscoveredWorkload
DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
Fields | |
---|---|
name |
Identifier. The resource name of the discovered workload. Format: |
workload_ |
Output only. Reference of an underlying compute resource represented by the Workload. These are immutable. |
workload_ |
Output only. Properties of an underlying compute resource represented by the Workload. These are immutable. |
Environment
Environment of the Application, Service, or Workload
Fields | |
---|---|
environment |
Optional. Environment name. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead. |
type |
Required. Environment Type. |
Type
Environment Type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified type. |
PRODUCTION |
Production environment. |
STAGING |
Staging environment. |
TEST |
Test environment. |
DEVELOPMENT |
Development environment. |
FindUnregisteredServicesRequest
Request for FindUnregisteredServices.
Fields | |
---|---|
parent |
Required. Project and location to find unregistered Discovered Services on. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
FindUnregisteredServicesResponse
Response for FindUnregisteredServices.
Fields | |
---|---|
discovered_ |
List of Discovered Services. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
FindUnregisteredWorkloadsRequest
Request for FindUnregisteredWorkloads.
Fields | |
---|---|
parent |
Required. Project and location to find unregistered Discovered Workloads on. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
FindUnregisteredWorkloadsResponse
Response for FindUnregisteredWorkloads.
Fields | |
---|---|
discovered_ |
List of Discovered Workloads. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
GetApplicationRequest
Request for GetApplication.
Fields | |
---|---|
name |
Required. Fully qualified name of the Application to fetch. Expected format: |
GetDiscoveredServiceRequest
Request for GetDiscoveredService.
Fields | |
---|---|
name |
Required. Fully qualified name of the Discovered Service to fetch. Expected format: |
GetDiscoveredWorkloadRequest
Request for GetDiscoveredWorkload.
Fields | |
---|---|
name |
Required. Fully qualified name of the Discovered Workload to fetch. Expected format: |
GetServiceProjectAttachmentRequest
Request for GetServiceProjectAttachment.
Fields | |
---|---|
name |
Required. Fully qualified name of the service project attachment to retrieve. Expected format: |
GetServiceRequest
Request for GetService.
Fields | |
---|---|
name |
Required. Fully qualified name of the Service to fetch. Expected format: |
GetWorkloadRequest
Request for GetWorkload.
Fields | |
---|---|
name |
Required. Fully qualified name of the Workload to fetch. Expected format: |
ListApplicationsRequest
Request for ListApplications.
Fields | |
---|---|
parent |
Required. Project and location to list Applications on. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
ListApplicationsResponse
Response for ListApplications.
Fields | |
---|---|
applications[] |
List of Applications. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListDiscoveredServicesRequest
Request for ListDiscoveredServices.
Fields | |
---|---|
parent |
Required. Project and location to list Discovered Services on. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
ListDiscoveredServicesResponse
Response for ListDiscoveredServices.
Fields | |
---|---|
discovered_ |
List of Discovered Services. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListDiscoveredWorkloadsRequest
Request for ListDiscoveredWorkloads.
Fields | |
---|---|
parent |
Required. Project and location to list Discovered Workloads on. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
ListDiscoveredWorkloadsResponse
Response for ListDiscoveredWorkloads.
Fields | |
---|---|
discovered_ |
List of Discovered Workloads. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListServiceProjectAttachmentsRequest
Request for ListServiceProjectAttachments.
Fields | |
---|---|
parent |
Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
ListServiceProjectAttachmentsResponse
Response for ListServiceProjectAttachments.
Fields | |
---|---|
service_ |
List of service project attachments. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListServicesRequest
Request for ListServices.
Fields | |
---|---|
parent |
Required. Fully qualified name of the parent Application to list Services for. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results |
order_ |
Optional. Hint for how to order the results |
ListServicesResponse
Response for ListServices.
Fields | |
---|---|
services[] |
List of Services. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListWorkloadsRequest
Request for ListWorkloads.
Fields | |
---|---|
parent |
Required. Fully qualified name of the parent Application to list Workloads for. Expected format: |
page_ |
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_ |
Optional. A token identifying a page of results the server should return. |
filter |
Optional. Filtering results. |
order_ |
Optional. Hint for how to order the results. |
ListWorkloadsResponse
Response for ListWorkloads.
Fields | |
---|---|
workloads[] |
List of Workloads. |
next_ |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
LookupDiscoveredServiceRequest
Request for LookupDiscoveredService.
Fields | |
---|---|
parent |
Required. Host project ID and location to lookup Discovered Service in. Expected format: |
uri |
Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed. |
LookupDiscoveredServiceResponse
Response for LookupDiscoveredService.
Fields | |
---|---|
discovered_ |
Discovered Service if exists, empty otherwise. |
LookupDiscoveredWorkloadRequest
Request for LookupDiscoveredWorkload.
Fields | |
---|---|
parent |
Required. Host project ID and location to lookup Discovered Workload in. Expected format: |
uri |
Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed. |
LookupDiscoveredWorkloadResponse
Response for LookupDiscoveredWorkload.
Fields | |
---|---|
discovered_ |
Discovered Workload if exists, empty otherwise. |
LookupServiceProjectAttachmentRequest
Request for LookupServiceProjectAttachment.
Fields | |
---|---|
name |
Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: |
LookupServiceProjectAttachmentResponse
Response for LookupServiceProjectAttachment.
Fields | |
---|---|
service_ |
Service project attachment for a project if exists, empty otherwise. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_ |
Output only. The time the operation was created. |
end_ |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_ |
Output only. Human-readable status of the operation, if any. |
requested_ |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_ |
Output only. API version used to start the operation. |
Scope
Scope of an application.
Fields | |
---|---|
type |
Required. Scope Type. |
Type
Scope Type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified type. |
REGIONAL |
Regional type. |
GLOBAL |
Global type. |
Service
Service is an App Hub data model that contains a discovered service, which represents a network or API interface that exposes some functionality to clients for consumption over the network.
Fields | |
---|---|
name |
Identifier. The resource name of a Service. Format: |
display_ |
Optional. User-defined name for the Service. Can have a maximum length of 63 characters. |
description |
Optional. User-defined description of a Service. Can have a maximum length of 2048 characters. |
service_ |
Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable. |
service_ |
Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable. |
attributes |
Optional. Consumer provided attributes. |
discovered_ |
Required. Immutable. The resource name of the original discovered service. |
create_ |
Output only. Create time. |
update_ |
Output only. Update time. |
uid |
Output only. A universally unique identifier (UUID) for the |
state |
Output only. Service state. |
State
Service state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
CREATING |
The service is being created. |
ACTIVE |
The service is ready. |
DELETING |
The service is being deleted. |
DETACHED |
The underlying networking resources have been deleted. |
ServiceProjectAttachment
ServiceProjectAttachment represents an attachment from a service project to a host project. Service projects contain the underlying cloud infrastructure resources, and expose these resources to the host project through a ServiceProjectAttachment. With the attachments, the host project can provide an aggregated view of resources across all service projects.
Fields | |
---|---|
name |
Identifier. The resource name of a ServiceProjectAttachment. Format: |
service_ |
Required. Immutable. Service project name in the format: |
create_ |
Output only. Create time. |
uid |
Output only. A globally unique identifier (in UUID4 format) for the |
state |
Output only. ServiceProjectAttachment state. |
State
ServiceProjectAttachment state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
CREATING |
The ServiceProjectAttachment is being created. |
ACTIVE |
The ServiceProjectAttachment is ready. This means Services and Workloads under the corresponding ServiceProjectAttachment is ready for registration. |
DELETING |
The ServiceProjectAttachment is being deleted. |
ServiceProperties
Properties of an underlying cloud resource that can comprise a Service.
Fields | |
---|---|
gcp_ |
Output only. The service project identifier that the underlying cloud resource resides in. |
location |
Output only. The location that the underlying resource resides in, for example, us-west1. |
zone |
Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a). |
ServiceReference
Reference to an underlying networking resource that can comprise a Service.
Fields | |
---|---|
uri |
Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service. |
path |
Output only. Additional path under the resource URI (demultiplexing one resource URI into multiple entries). Smallest unit a policy can be attached to. Examples: URL Map path entry. |
UpdateApplicationRequest
Request for UpdateApplication.
Fields | |
---|---|
update_ |
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. |
application |
Required. The resource being updated. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
UpdateServiceRequest
Request for UpdateService.
Fields | |
---|---|
update_ |
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. |
service |
Required. The resource being updated. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
UpdateWorkloadRequest
Request for UpdateWorkload.
Fields | |
---|---|
update_ |
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. |
workload |
Required. The resource being updated. |
request_ |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
Workload
Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.
Fields | |
---|---|
name |
Identifier. The resource name of the Workload. Format: |
display_ |
Optional. User-defined name for the Workload. Can have a maximum length of 63 characters. |
description |
Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters. |
workload_ |
Output only. Reference of an underlying compute resource represented by the Workload. These are immutable. |
workload_ |
Output only. Properties of an underlying compute resource represented by the Workload. These are immutable. |
discovered_ |
Required. Immutable. The resource name of the original discovered workload. |
attributes |
Optional. Consumer provided attributes. |
create_ |
Output only. Create time. |
update_ |
Output only. Update time. |
uid |
Output only. A universally unique identifier (UUID) for the |
state |
Output only. Workload state. |
State
Workload state.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unspecified state. |
CREATING |
The Workload is being created. |
ACTIVE |
The Workload is ready. |
DELETING |
The Workload is being deleted. |
DETACHED |
The underlying compute resources have been deleted. |
WorkloadProperties
Properties of an underlying compute resource represented by the Workload.
Fields | |
---|---|
gcp_ |
Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. |
location |
Output only. The location that the underlying compute resource resides in (for example, us-west1). |
zone |
Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a). |
WorkloadReference
Reference of an underlying compute resource represented by the Workload.
Fields | |
---|---|
uri |
Output only. The underlying compute resource uri. |