Package google.cloud.apphub.v1

Index

AppHub

The App Hub API allows you to manage App Hub resources.

CreateApplication

rpc CreateApplication(CreateApplicationRequest) returns (Operation)

Creates an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.applications.create

For more information, see the IAM documentation.
CreateService

rpc CreateService(CreateServiceRequest) returns (Operation)

Creates a Service in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.services.create

Requires the following IAM permission on the discoveredService resource:

  • apphub.discoveredServices.register

For more information, see the IAM documentation.
CreateServiceProjectAttachment

rpc CreateServiceProjectAttachment(CreateServiceProjectAttachmentRequest) returns (Operation)

Attaches a service project to the host project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.serviceProjectAttachments.create

Requires the following IAM permission on the serviceProject resource:

  • apphub.serviceProjectAttachments.attach

For more information, see the IAM documentation.
CreateWorkload

rpc CreateWorkload(CreateWorkloadRequest) returns (Operation)

Creates a Workload in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.workloads.create

Requires the following IAM permission on the discoveredWorkload resource:

  • apphub.discoveredWorkloads.register

For more information, see the IAM documentation.
DeleteApplication

rpc DeleteApplication(DeleteApplicationRequest) returns (Operation)

Deletes an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.applications.delete

For more information, see the IAM documentation.
DeleteService

rpc DeleteService(DeleteServiceRequest) returns (Operation)

Deletes a Service from an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.services.delete

For more information, see the IAM documentation.
DeleteServiceProjectAttachment

rpc DeleteServiceProjectAttachment(DeleteServiceProjectAttachmentRequest) returns (Operation)

Deletes a service project attachment.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.serviceProjectAttachments.delete

For more information, see the IAM documentation.
DeleteWorkload

rpc DeleteWorkload(DeleteWorkloadRequest) returns (Operation)

Deletes a Workload from an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.workloads.delete

For more information, see the IAM documentation.
DetachServiceProjectAttachment

rpc DetachServiceProjectAttachment(DetachServiceProjectAttachmentRequest) returns (DetachServiceProjectAttachmentResponse)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.serviceProjectAttachments.detach

For more information, see the IAM documentation.
GetApplication

rpc GetApplication(GetApplicationRequest) returns (Application)

Gets an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.applications.get

For more information, see the IAM documentation.
GetDiscoveredService

rpc GetDiscoveredService(GetDiscoveredServiceRequest) returns (DiscoveredService)

Gets a Discovered Service in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.discoveredServices.get

For more information, see the IAM documentation.
GetDiscoveredWorkload

rpc GetDiscoveredWorkload(GetDiscoveredWorkloadRequest) returns (DiscoveredWorkload)

Gets a Discovered Workload in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.discoveredWorkloads.get

For more information, see the IAM documentation.
GetService

rpc GetService(GetServiceRequest) returns (Service)

Gets a Service in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.services.get

For more information, see the IAM documentation.
GetServiceProjectAttachment

rpc GetServiceProjectAttachment(GetServiceProjectAttachmentRequest) returns (ServiceProjectAttachment)

Gets a service project attachment.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.serviceProjectAttachments.get

For more information, see the IAM documentation.
GetWorkload

rpc GetWorkload(GetWorkloadRequest) returns (Workload)

Gets a Workload in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.workloads.get

For more information, see the IAM documentation.
ListApplications

rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse)

Lists Applications in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.applications.list

For more information, see the IAM documentation.
ListDiscoveredServices

rpc ListDiscoveredServices(ListDiscoveredServicesRequest) returns (ListDiscoveredServicesResponse)

Lists Discovered Services that can be added to an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.discoveredServices.list

For more information, see the IAM documentation.
ListDiscoveredWorkloads

rpc ListDiscoveredWorkloads(ListDiscoveredWorkloadsRequest) returns (ListDiscoveredWorkloadsResponse)

Lists Discovered Workloads that can be added to an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.discoveredWorkloads.list

For more information, see the IAM documentation.
ListServiceProjectAttachments

rpc ListServiceProjectAttachments(ListServiceProjectAttachmentsRequest) returns (ListServiceProjectAttachmentsResponse)

Lists service projects attached to the host project.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.serviceProjectAttachments.list

For more information, see the IAM documentation.
ListServices

rpc ListServices(ListServicesRequest) returns (ListServicesResponse)

Lists Services in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.services.list

For more information, see the IAM documentation.
ListWorkloads

rpc ListWorkloads(ListWorkloadsRequest) returns (ListWorkloadsResponse)

Lists Workloads in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.workloads.list

For more information, see the IAM documentation.
LookupDiscoveredService

rpc LookupDiscoveredService(LookupDiscoveredServiceRequest) returns (LookupDiscoveredServiceResponse)

Lists a Discovered Service in a host project and location, with a given resource URI.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.discoveredServices.list

For more information, see the IAM documentation.
LookupDiscoveredWorkload

rpc LookupDiscoveredWorkload(LookupDiscoveredWorkloadRequest) returns (LookupDiscoveredWorkloadResponse)

Lists a Discovered Workload in a host project and location, with a given resource URI.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apphub.discoveredWorkloads.list

For more information, see the IAM documentation.
LookupServiceProjectAttachment

rpc LookupServiceProjectAttachment(LookupServiceProjectAttachmentRequest) returns (LookupServiceProjectAttachmentResponse)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.serviceProjectAttachments.lookup

For more information, see the IAM documentation.
UpdateApplication

rpc UpdateApplication(UpdateApplicationRequest) returns (Operation)

Updates an Application in a host project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.applications.update

For more information, see the IAM documentation.
UpdateService

rpc UpdateService(UpdateServiceRequest) returns (Operation)

Updates a Service in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.services.update

For more information, see the IAM documentation.
UpdateWorkload

rpc UpdateWorkload(UpdateWorkloadRequest) returns (Operation)

Updates a Workload in an Application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.workloads.update

For more information, see the IAM documentation.

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

string

Identifier. The resource name of an Application. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}"
display_name

string

Optional. User-defined name for the Application. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of an Application. Can have a maximum length of 2048 characters.
attributes

Attributes

Optional. Consumer provided attributes.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
scope

Scope

Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered.
uid

string

Output only. A universally unique identifier (in UUID4 format) for the Application.
state

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

Criticality

Optional. User-defined criticality information.
environment

Environment

Optional. User-defined environment information.
developer_owners[]

ContactInfo

Optional. Developer team that owns development and coding.
operator_owners[]

ContactInfo

Optional. Operator team that ensures runtime and operations.
business_owners[]

ContactInfo

Optional. Business team that ensures user needs are met and value is delivered

ContactInfo

Contact information of stakeholders.

Fields
display_name

string

Optional. Contact's name. Can have a maximum length of 63 characters.
email

string

Required. Email address of the contacts.

CreateApplicationRequest

Request for CreateApplication.

Fields
parent

string

Required. Project and location to create Application in. Expected format: projects/{project}/locations/{location}.
application_id

string

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

Application

Required. The resource being created
request_id

string

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

string

Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: projects/{project}/locations/{location}.
service_project_attachment_id

string

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_project_attachment

ServiceProjectAttachment

Required. The resource being created.
request_id

string

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

string

Required. Fully qualified name of the parent Application to create the Service in. Expected format: projects/{project}/locations/{location}/applications/{application}.
service_id

string

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

Service

Required. The resource being created.
request_id

string

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

string

Required. Fully qualified name of the Application to create Workload in. Expected format: projects/{project}/locations/{location}/applications/{application}.
workload_id

string

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

Workload

Required. The resource being created.
request_id

string

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
type

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

string

Required. Fully qualified name of the Application to delete. Expected format: projects/{project}/locations/{location}/applications/{application}.
request_id

string

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

string

Required. Fully qualified name of the service project attachment to delete. Expected format: projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}.
request_id

string

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

string

Required. Fully qualified name of the Service to delete from an Application. Expected format: projects/{project}/locations/{location}/applications/{application}/services/{service}.
request_id

string

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

string

Required. Fully qualified name of the Workload to delete from an Application. Expected format: projects/{project}/locations/{location}/applications/{application}/workloads/{workload}.
request_id

string

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

string

Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: projects/{project}/locations/{location}.

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

string

Identifier. The resource name of the discovered service. Format: "projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"
service_reference

ServiceReference

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
service_properties

ServiceProperties

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

string

Identifier. The resource name of the discovered workload. Format: "projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"
workload_reference

WorkloadReference

Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
workload_properties

WorkloadProperties

Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.

Environment

Environment of the Application, Service, or Workload

Fields
type

Type

Required. Environment Type.

Type

Environment Type.

Enums
TYPE_UNSPECIFIED Unspecified type.
PRODUCTION Production environment.
STAGING Staging environment.
TEST Test environment.
DEVELOPMENT Development environment.

GetApplicationRequest

Request for GetApplication.

Fields
name

string

Required. Fully qualified name of the Application to fetch. Expected format: projects/{project}/locations/{location}/applications/{application}.

GetDiscoveredServiceRequest

Request for GetDiscoveredService.

Fields
name

string

Required. Fully qualified name of the Discovered Service to fetch. Expected format: projects/{project}/locations/{location}/discoveredServices/{discoveredService}.

GetDiscoveredWorkloadRequest

Request for GetDiscoveredWorkload.

Fields
name

string

Required. Fully qualified name of the Discovered Workload to fetch. Expected format: projects/{project}/locations/{location}/discoveredWorkloads/{discoveredWorkload}.

GetServiceProjectAttachmentRequest

Request for GetServiceProjectAttachment.

Fields
name

string

Required. Fully qualified name of the service project attachment to retrieve. Expected format: projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}.

GetServiceRequest

Request for GetService.

Fields
name

string

Required. Fully qualified name of the Service to fetch. Expected format: projects/{project}/locations/{location}/applications/{application}/services/{service}.

GetWorkloadRequest

Request for GetWorkload.

Fields
name

string

Required. Fully qualified name of the Workload to fetch. Expected format: projects/{project}/locations/{location}/applications/{application}/workloads/{workload}.

ListApplicationsRequest

Request for ListApplications.

Fields
parent

string

Required. Project and location to list Applications on. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListApplicationsResponse

Response for ListApplications.

Fields
applications[]

Application

List of Applications.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListDiscoveredServicesRequest

Request for ListDiscoveredServices.

Fields
parent

string

Required. Project and location to list Discovered Services on. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListDiscoveredServicesResponse

Response for ListDiscoveredServices.

Fields
discovered_services[]

DiscoveredService

List of Discovered Services.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListDiscoveredWorkloadsRequest

Request for ListDiscoveredWorkloads.

Fields
parent

string

Required. Project and location to list Discovered Workloads on. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListDiscoveredWorkloadsResponse

Response for ListDiscoveredWorkloads.

Fields
discovered_workloads[]

DiscoveredWorkload

List of Discovered Workloads.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListServiceProjectAttachmentsRequest

Request for ListServiceProjectAttachments.

Fields
parent

string

Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: projects/{project}/locations/{location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListServiceProjectAttachmentsResponse

Response for ListServiceProjectAttachments.

Fields
service_project_attachments[]

ServiceProjectAttachment

List of service project attachments.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListServicesRequest

Request for ListServices.

Fields
parent

string

Required. Fully qualified name of the parent Application to list Services for. Expected format: projects/{project}/locations/{location}/applications/{application}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results
order_by

string

Optional. Hint for how to order the results

ListServicesResponse

Response for ListServices.

Fields
services[]

Service

List of Services.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

ListWorkloadsRequest

Request for ListWorkloads.

Fields
parent

string

Required. Fully qualified name of the parent Application to list Workloads for. Expected format: projects/{project}/locations/{location}/applications/{application}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListWorkloadsResponse

Response for ListWorkloads.

Fields
workloads[]

Workload

List of Workloads.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

LookupDiscoveredServiceRequest

Request for LookupDiscoveredService.

Fields
parent

string

Required. Host project ID and location to lookup Discovered Service in. Expected format: projects/{project}/locations/{location}.
uri

string

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_service

DiscoveredService

Discovered Service if exists, empty otherwise.

LookupDiscoveredWorkloadRequest

Request for LookupDiscoveredWorkload.

Fields
parent

string

Required. Host project ID and location to lookup Discovered Workload in. Expected format: projects/{project}/locations/{location}.
uri

string

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_workload

DiscoveredWorkload

Discovered Workload if exists, empty otherwise.

LookupServiceProjectAttachmentRequest

Request for LookupServiceProjectAttachment.

Fields
name

string

Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: projects/{project}/locations/{location}.

LookupServiceProjectAttachmentResponse

Response for LookupServiceProjectAttachment.

Fields
service_project_attachment

ServiceProjectAttachment

Service project attachment for a project if exists, empty otherwise.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

Scope

Scope of an application.

Fields
type

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

string

Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"
display_name

string

Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.
service_reference

ServiceReference

Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
service_properties

ServiceProperties

Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
attributes

Attributes

Optional. Consumer provided attributes.
discovered_service

string

Required. Immutable. The resource name of the original discovered service.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
uid

string

Output only. A universally unique identifier (UUID) for the Service in the UUID4 format.
state

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

string

Identifier. The resource name of a ServiceProjectAttachment. Format: "projects/{host-project-id}/locations/global/serviceProjectAttachments/{service-project-id}."
service_project

string

Required. Immutable. Service project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
create_time

Timestamp

Output only. Create time.
uid

string

Output only. A globally unique identifier (in UUID4 format) for the ServiceProjectAttachment.
state

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_project

string

Output only. The service project identifier that the underlying cloud resource resides in.
location

string

Output only. The location that the underlying resource resides in, for example, us-west1.
zone

string

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

string

Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service.

UpdateApplicationRequest

Request for UpdateApplication.

Fields
update_mask

FieldMask

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

Application

Required. The resource being updated.
request_id

string

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_mask

FieldMask

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

Service

Required. The resource being updated.
request_id

string

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_mask

FieldMask

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

Workload

Required. The resource being updated.
request_id

string

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

string

Identifier. The resource name of the Workload. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"
display_name

string

Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
workload_reference

WorkloadReference

Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
workload_properties

WorkloadProperties

Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
discovered_workload

string

Required. Immutable. The resource name of the original discovered workload.
attributes

Attributes

Optional. Consumer provided attributes.
create_time

Timestamp

Output only. Create time.
update_time

Timestamp

Output only. Update time.
uid

string

Output only. A universally unique identifier (UUID) for the Workload in the UUID4 format.
state

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_project

string

Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
location

string

Output only. The location that the underlying compute resource resides in (for example, us-west1).
zone

string

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

string

Output only. The underlying compute resource uri.