{ "version_module": true, "fullyEncodeReservedExpansion": true, "protocol": "rest", "description": "App Hub lets you build, operate, and manage applications on Google Cloud.", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerDomain": "google.com", "revision": "20260904", "batchPath": "batch", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "baseUrl": "https://apphub.googleapis.com/", "parameters": { "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "default": "json", "location": "query", "description": "Data format for response.", "type": "string" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" } }, "documentationLink": "https://cloud.google.com/app-hub/docs/", "version": "v1alpha", "canonicalName": "App Hub", "id": "apphub:v1alpha", "rootUrl": "https://apphub.googleapis.com/", "basePath": "", "title": "App Hub API", "ownerName": "Google", "servicePath": "", "discoveryVersion": "v1", "resources": { "projects": { "resources": { "locations": { "resources": { "serviceProjectAttachments": { "methods": { "create": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments", "description": "Attaches a service project to the host project.", "parameterOrder": [ "parent" ], "request": { "$ref": "ServiceProjectAttachment" }, "httpMethod": "POST", "response": { "$ref": "Operation" }, "path": "v1alpha/{+parent}/serviceProjectAttachments", "id": "apphub.projects.locations.serviceProjectAttachments.create", "parameters": { "requestId": { "description": "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).", "location": "query", "type": "string" }, "serviceProjectAttachmentId": { "type": "string", "location": "query", "description": "Required. The service project attachment identifier must contain the project id of the service project specified in the service_project_attachment.service_project field." }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. Host project ID and location to which service project is being attached. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "ServiceProjectAttachment" }, "description": "Gets a service project attachment.", "id": "apphub.projects.locations.serviceProjectAttachments.get", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$", "type": "string", "description": "Required. Fully qualified name of the service project attachment to retrieve. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`." } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments", "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Host project ID and location to list service project attachments. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "id": "apphub.projects.locations.serviceProjectAttachments.list", "httpMethod": "GET", "response": { "$ref": "ListServiceProjectAttachmentsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists service projects attached to the host project.", "path": "v1alpha/{+parent}/serviceProjectAttachments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameters": { "requestId": { "location": "query", "type": "string", "description": "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)." }, "name": { "required": true, "location": "path", "type": "string", "description": "Required. Fully qualified name of the service project attachment to delete. Expected format: `projects/{project}/locations/{location}/serviceProjectAttachments/{serviceProjectAttachment}`.", "pattern": "^projects/[^/]+/locations/[^/]+/serviceProjectAttachments/[^/]+$" } }, "id": "apphub.projects.locations.serviceProjectAttachments.delete", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a service project attachment.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "path": "v1alpha/{+name}" } } }, "extendedMetadataSchemas": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "response": { "$ref": "ExtendedMetadataSchema" }, "httpMethod": "GET", "description": "Gets an Extended Metadata Schema.", "id": "apphub.projects.locations.extendedMetadataSchemas.get", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/extendedMetadataSchemas/{extendedMetadataSchemasId}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "description": "Required. Schema resource name. Format: `projects/{project}/locations/{location}/extendedMetadataSchemas/{extended_metadata_schema}`. `{extended_metadata_schema}` has the format `\"apphub.googleapis.com/{SchemaName}\"`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/extendedMetadataSchemas/.*$" } } }, "list": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/extendedMetadataSchemas", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Optional. A token identifying a page of results the server should return." }, "parent": { "type": "string", "description": "Required. Project and location to list Extended Metadata Schemas on. Expected format: `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListExtendedMetadataSchemasResponse" }, "path": "v1alpha/{+parent}/extendedMetadataSchemas", "id": "apphub.projects.locations.extendedMetadataSchemas.list", "description": "Lists Extended Metadata Schemas available in a host project and location." } } }, "applications": { "methods": { "testIamPermissions": { "parameters": { "resource": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:testIamPermissions", "path": "v1alpha/{+resource}:testIamPermissions", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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.", "response": { "$ref": "TestIamPermissionsResponse" }, "request": { "$ref": "TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "id": "apphub.projects.locations.applications.testIamPermissions" }, "create": { "response": { "$ref": "Operation" }, "description": "Creates an Application in a host project and location.", "path": "v1alpha/{+parent}/applications", "parameterOrder": [ "parent" ], "parameters": { "applicationId": { "type": "string", "description": "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.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. Project and location to create Application in. Expected format: `projects/{project}/locations/{location}`." }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications", "id": "apphub.projects.locations.applications.create", "request": { "$ref": "Application" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "httpMethod": "POST", "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, "type": "string", "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:setIamPolicy", "path": "v1alpha/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apphub.projects.locations.applications.setIamPolicy" }, "delete": { "description": "Deletes an Application in a host project and location.", "parameters": { "requestId": { "description": "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).", "type": "string", "location": "query" }, "name": { "required": true, "location": "path", "type": "string", "description": "Required. Fully qualified name of the Application to delete. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "apphub.projects.locations.applications.delete", "response": { "$ref": "Operation" }, "path": "v1alpha/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}" }, "get": { "id": "apphub.projects.locations.applications.get", "description": "Gets an Application in a host project and location.", "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "Required. Fully qualified name of the Application to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}", "httpMethod": "GET", "response": { "$ref": "Application" } }, "list": { "id": "apphub.projects.locations.applications.list", "response": { "$ref": "ListApplicationsResponse" }, "httpMethod": "GET", "description": "Lists Applications in a host project and location.", "parameterOrder": [ "parent" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/applications", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Project and location to list Applications on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "required": true }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results." }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results." } } }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an Application in a host project and location.", "request": { "$ref": "Application" }, "id": "apphub.projects.locations.applications.patch", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "type": "string", "description": "Identifier. The resource name of an Application. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}\"`" }, "updateMask": { "description": "Optional. 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.", "type": "string", "location": "query", "format": "google-fieldmask" }, "requestId": { "type": "string", "location": "query", "description": "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)." } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}" }, "getIamPolicy": { "parameterOrder": [ "resource" ], "httpMethod": "GET", "response": { "$ref": "Policy" }, "id": "apphub.projects.locations.applications.getIamPolicy", "path": "v1alpha/{+resource}:getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "format": "int32", "type": "integer", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "location": "path" } }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "workloads": { "methods": { "patch": { "parameters": { "updateMask": { "location": "query", "description": "Optional. 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.", "format": "google-fieldmask", "type": "string" }, "requestId": { "type": "string", "description": "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).", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "description": "Identifier. The resource name of the Workload. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}\"`", "type": "string", "location": "path", "required": true } }, "response": { "$ref": "Operation" }, "id": "apphub.projects.locations.applications.workloads.patch", "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}", "httpMethod": "PATCH", "description": "Updates a Workload in an Application.", "request": { "$ref": "Workload" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "id": "apphub.projects.locations.applications.workloads.create", "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "Workload" }, "path": "v1alpha/{+parent}/workloads", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Workload in an Application.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads", "parameterOrder": [ "parent" ], "parameters": { "workloadId": { "location": "query", "description": "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.", "type": "string" }, "parent": { "description": "Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$" }, "requestId": { "description": "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).", "type": "string", "location": "query" } } }, "delete": { "description": "Deletes a Workload from an Application.", "response": { "$ref": "Operation" }, "id": "apphub.projects.locations.applications.workloads.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}", "path": "v1alpha/{+name}", "parameters": { "name": { "description": "Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "type": "string" }, "requestId": { "location": "query", "description": "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).", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "description": "Gets a Workload in an Application.", "response": { "$ref": "Workload" }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}", "parameters": { "name": { "type": "string", "description": "Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/workloads/[^/]+$", "required": true } }, "id": "apphub.projects.locations.applications.workloads.get" }, "list": { "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results." }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results." }, "parent": { "location": "path", "description": "Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "required": true, "type": "string" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/workloads", "httpMethod": "GET", "id": "apphub.projects.locations.applications.workloads.list", "parameterOrder": [ "parent" ], "response": { "$ref": "ListWorkloadsResponse" }, "description": "Lists Workloads in an Application." } } }, "services": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, "type": "string", "description": "Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`." } }, "description": "Gets a Service in an Application.", "id": "apphub.projects.locations.applications.services.get", "response": { "$ref": "Service" } }, "create": { "id": "apphub.projects.locations.applications.services.create", "response": { "$ref": "Operation" }, "request": { "$ref": "Service" }, "path": "v1alpha/{+parent}/services", "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "serviceId": { "description": "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.", "type": "string", "location": "query" }, "requestId": { "description": "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).", "location": "query", "type": "string" }, "parent": { "description": "Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$" } }, "description": "Creates a Service in an Application." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", "id": "apphub.projects.locations.applications.services.patch", "request": { "$ref": "Service" }, "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. 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.", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Identifier. The resource name of a Service. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}\"`" }, "requestId": { "description": "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).", "type": "string", "location": "query" } }, "path": "v1alpha/{+name}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "description": "Updates a Service in an Application." }, "list": { "description": "Lists Services in an Application.", "path": "v1alpha/{+parent}/services", "id": "apphub.projects.locations.applications.services.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services", "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results" }, "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "parent": { "required": true, "description": "Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project}/locations/{location}/applications/{application}`.", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+$", "location": "path", "type": "string" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListServicesResponse" } }, "delete": { "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/applications/[^/]+/services/[^/]+$", "required": true, "description": "Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`." }, "requestId": { "type": "string", "description": "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).", "location": "query" } }, "id": "apphub.projects.locations.applications.services.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Service from an Application.", "parameterOrder": [ "name" ] } } } } }, "discoveredServices": { "methods": { "list": { "description": "Lists Discovered Services that can be added to an Application in a host project and location.", "path": "v1alpha/{+parent}/discoveredServices", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices", "id": "apphub.projects.locations.discoveredServices.list", "parameters": { "parent": { "type": "string", "description": "Required. Project and location to list Discovered Services on. Expected format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. Hint for how to order the results.", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDiscoveredServicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "get": { "description": "Gets a Discovered Service in a host project and location.", "httpMethod": "GET", "path": "v1alpha/{+name}", "response": { "$ref": "DiscoveredService" }, "id": "apphub.projects.locations.discoveredServices.get", "parameterOrder": [ "name" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices/{discoveredServicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project}/locations/{location}/discoveredServices/{discoveredService}`.", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredServices/[^/]+$", "required": true, "type": "string" } } }, "lookup": { "description": "Lists a Discovered Service in a host project and location, with a given resource URI.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices:lookup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "uri": { "description": "Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed.", "type": "string", "location": "query" }, "parent": { "type": "string", "description": "Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project}/locations/{location}`.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1alpha/{+parent}/discoveredServices:lookup", "response": { "$ref": "LookupDiscoveredServiceResponse" }, "parameterOrder": [ "parent" ], "id": "apphub.projects.locations.discoveredServices.lookup", "httpMethod": "GET" }, "findUnregistered": { "path": "v1alpha/{+parent}/discoveredServices:findUnregistered", "description": "Finds unregistered services in a host project and location.", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results.", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Project and location to find unregistered Discovered Services on. Expected format: `projects/{project}/locations/{location}`." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredServices:findUnregistered", "id": "apphub.projects.locations.discoveredServices.findUnregistered", "httpMethod": "GET", "response": { "$ref": "FindUnregisteredServicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "discoveredWorkloads": { "methods": { "get": { "id": "apphub.projects.locations.discoveredWorkloads.get", "path": "v1alpha/{+name}", "description": "Gets a Discovered Workload in a host project and location.", "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads/{discoveredWorkloadsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project}/locations/{location}/discoveredWorkloads/{discoveredWorkload}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/discoveredWorkloads/[^/]+$", "location": "path" } }, "response": { "$ref": "DiscoveredWorkload" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads", "description": "Lists Discovered Workloads that can be added to an Application in a host project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "apphub.projects.locations.discoveredWorkloads.list", "response": { "$ref": "ListDiscoveredWorkloadsResponse" }, "path": "v1alpha/{+parent}/discoveredWorkloads", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "filter": { "description": "Optional. Filtering results.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`.", "required": true, "location": "path", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" } } }, "lookup": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apphub.projects.locations.discoveredWorkloads.lookup", "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads:lookup", "path": "v1alpha/{+parent}/discoveredWorkloads:lookup", "description": "Lists a Discovered Workload in a host project and location, with a given resource URI.", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project}/locations/{location}`.", "required": true, "type": "string" }, "uri": { "type": "string", "location": "query", "description": "Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed." } }, "parameterOrder": [ "parent" ], "response": { "$ref": "LookupDiscoveredWorkloadResponse" } }, "findUnregistered": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Project and location to find unregistered Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "required": true }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results.", "type": "string" }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" } }, "description": "Finds unregistered workloads in a host project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads:findUnregistered", "parameterOrder": [ "parent" ], "path": "v1alpha/{+parent}/discoveredWorkloads:findUnregistered", "id": "apphub.projects.locations.discoveredWorkloads.findUnregistered", "response": { "$ref": "FindUnregisteredWorkloadsResponse" }, "httpMethod": "GET" } } }, "operations": { "methods": { "cancel": { "description": "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`.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string" } }, "response": { "$ref": "Empty" }, "id": "apphub.projects.locations.operations.cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "path": "v1alpha/{+name}:cancel" }, "get": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1alpha/{+name}", "httpMethod": "GET", "description": "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "apphub.projects.locations.operations.get", "response": { "$ref": "Operation" }, "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ] }, "delete": { "response": { "$ref": "Empty" }, "id": "apphub.projects.locations.operations.delete", "description": "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`.", "httpMethod": "DELETE", "path": "v1alpha/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" } }, "path": "v1alpha/{+name}/operations", "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "id": "apphub.projects.locations.operations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } } }, "methods": { "updateBoundary": { "request": { "$ref": "Boundary" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/boundary", "path": "v1alpha/{+name}", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Boundary resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten." }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/boundary$", "required": true, "type": "string", "description": "Identifier. The resource name of the boundary. Format: \"projects/{project}/locations/{location}/boundary\"" }, "requestId": { "description": "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).", "type": "string", "location": "query" } }, "id": "apphub.projects.locations.updateBoundary", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "PATCH", "description": "Updates a Boundary." }, "getBoundary": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a Boundary.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/boundary", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the boundary to retrieve. Format: `projects/{project}/locations/{location}/boundary`.", "pattern": "^projects/[^/]+/locations/[^/]+/boundary$", "type": "string" } }, "path": "v1alpha/{+name}", "response": { "$ref": "Boundary" }, "id": "apphub.projects.locations.getBoundary" }, "list": { "id": "apphub.projects.locations.list", "response": { "$ref": "ListLocationsResponse" }, "path": "v1alpha/{+name}/locations", "httpMethod": "GET", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameters": { "filter": { "type": "string", "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, "pageSize": { "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "type": "integer" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "type": "string", "location": "query", "repeated": true }, "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" }, "name": { "location": "path", "type": "string", "required": true, "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$" } }, "flatPath": "v1alpha/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "id": "apphub.projects.locations.get", "response": { "$ref": "Location" }, "httpMethod": "GET", "path": "v1alpha/{+name}", "description": "Gets information about a location.", "parameterOrder": [ "name" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } } }, "lookupServiceProjectAttachment": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:lookupServiceProjectAttachment", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1alpha/{+name}:lookupServiceProjectAttachment", "response": { "$ref": "LookupServiceProjectAttachmentResponse" }, "id": "apphub.projects.locations.lookupServiceProjectAttachment", "parameterOrder": [ "name" ], "description": "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": "Required. Service project ID and location to lookup service project attachment for. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } } }, "detachServiceProjectAttachment": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:detachServiceProjectAttachment", "description": "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": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. Service project id and location to detach from a host project. Only global location is supported. Expected format: `projects/{project}/locations/{location}`.", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}:detachServiceProjectAttachment", "httpMethod": "POST", "response": { "$ref": "DetachServiceProjectAttachmentResponse" }, "request": { "$ref": "DetachServiceProjectAttachmentRequest" }, "id": "apphub.projects.locations.detachServiceProjectAttachment" } } } } } }, "kind": "discovery#restDescription", "schemas": { "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation", "properties": { "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "items": { "$ref": "Operation" }, "type": "array", "description": "A list of operations that matches the specified filter in the request." }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "DetachServiceProjectAttachmentResponse": { "properties": {}, "description": "Response for DetachServiceProjectAttachment.", "type": "object", "id": "DetachServiceProjectAttachmentResponse" }, "AuditLogConfig": { "properties": { "logType": { "description": "The log type that this config enables.", "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] }, "exemptedMembers": { "items": { "type": "string" }, "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array" } }, "id": "AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object" }, "Scope": { "description": "Scope of an application.", "properties": { "type": { "description": "Required. Scope Type.", "enumDescriptions": [ "Unspecified type.", "Regional type.", "Global type." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "REGIONAL", "GLOBAL" ] } }, "type": "object", "id": "Scope" }, "ListServiceProjectAttachmentsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "serviceProjectAttachments": { "type": "array", "items": { "$ref": "ServiceProjectAttachment" }, "description": "List of service project attachments." }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } }, "type": "object", "description": "Response for ListServiceProjectAttachments.", "id": "ListServiceProjectAttachmentsResponse" }, "FunctionalType": { "type": "object", "properties": { "type": { "type": "string", "description": "Output only. The functional type of a service or workload.", "enumDescriptions": [ "Unspecified type.", "Agent type.", "MCP Server type.", "Endpoint type." ], "enum": [ "TYPE_UNSPECIFIED", "AGENT", "MCP_SERVER", "ENDPOINT" ], "readOnly": true } }, "id": "FunctionalType", "description": "The functional type of a service or workload." }, "Service": { "id": "Service", "properties": { "createTime": { "description": "Output only. Create time.", "format": "google-datetime", "type": "string", "readOnly": true }, "displayName": { "type": "string", "description": "Optional. User-defined name for the Service. Can have a maximum length of 63 characters." }, "discoveredService": { "type": "string", "description": "Required. Immutable. The resource name of the original discovered service." }, "name": { "description": "Identifier. The resource name of a Service. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}\"`", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Update time.", "readOnly": true, "format": "google-datetime" }, "description": { "description": "Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.", "type": "string" }, "serviceReference": { "description": "Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.", "$ref": "ServiceReference", "readOnly": true }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "DETACHED" ], "description": "Output only. Service state.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state.", "The service is being created.", "The service is ready.", "The service is being deleted.", "The underlying networking resources have been deleted." ] }, "attributes": { "description": "Optional. Consumer provided attributes.", "$ref": "Attributes" }, "serviceProperties": { "description": "Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.", "readOnly": true, "$ref": "ServiceProperties" }, "uid": { "type": "string", "description": "Output only. A universally unique identifier (UUID) for the `Service` in the UUID4 format.", "readOnly": true } }, "description": "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.", "type": "object" }, "LookupDiscoveredWorkloadResponse": { "properties": { "discoveredWorkload": { "$ref": "DiscoveredWorkload", "description": "Discovered Workload if exists, empty otherwise." } }, "description": "Response for LookupDiscoveredWorkload.", "id": "LookupDiscoveredWorkloadResponse", "type": "object" }, "Attributes": { "type": "object", "description": "Consumer provided attributes.", "properties": { "environment": { "$ref": "Environment", "description": "Optional. User-defined environment information." }, "businessOwners": { "items": { "$ref": "ContactInfo" }, "description": "Optional. Business team that ensures user needs are met and value is delivered", "type": "array" }, "developerOwners": { "items": { "$ref": "ContactInfo" }, "type": "array", "description": "Optional. Developer team that owns development and coding." }, "operatorOwners": { "type": "array", "description": "Optional. Operator team that ensures runtime and operations.", "items": { "$ref": "ContactInfo" } }, "criticality": { "$ref": "Criticality", "description": "Optional. User-defined criticality information." } }, "id": "Attributes" }, "WorkloadReference": { "id": "WorkloadReference", "type": "object", "description": "Reference of an underlying compute resource represented by the Workload.", "properties": { "uri": { "description": "Output only. The underlying compute resource uri.", "type": "string", "readOnly": true } } }, "Environment": { "description": "Environment of the Application, Service, or Workload", "id": "Environment", "type": "object", "properties": { "type": { "description": "Required. Environment Type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "PRODUCTION", "STAGING", "TEST", "DEVELOPMENT" ], "enumDescriptions": [ "Unspecified type.", "Production environment.", "Staging environment.", "Test environment.", "Development environment." ] }, "environment": { "deprecated": true, "description": "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": "string" } } }, "Criticality": { "properties": { "missionCritical": { "description": "Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead.", "type": "boolean", "deprecated": true }, "level": { "description": "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.", "type": "string", "deprecated": true }, "type": { "description": "Required. Criticality Type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "MISSION_CRITICAL", "HIGH", "MEDIUM", "LOW" ], "enumDescriptions": [ "Unspecified type.", "Mission critical service, application or workload.", "High impact.", "Medium impact.", "Low impact." ] } }, "id": "Criticality", "type": "object", "description": "Criticality of the Application, Service, or Workload" }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations." }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "type": "object", "properties": { "policy": { "$ref": "Policy", "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`" } } }, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "id": "Expr" }, "Location": { "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" } }, "id": "Location" }, "ContactInfo": { "type": "object", "description": "Contact information of stakeholders.", "id": "ContactInfo", "properties": { "displayName": { "type": "string", "description": "Optional. Contact's name. Can have a maximum length of 63 characters." }, "email": { "type": "string", "description": "Required. Email address of the contacts." }, "channel": { "description": "Optional. Communication channel of the contacts.", "$ref": "Channel" } } }, "FindUnregisteredWorkloadsResponse": { "description": "Response for FindUnregisteredWorkloads.", "type": "object", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "discoveredWorkloads": { "description": "List of Discovered Workloads.", "items": { "$ref": "DiscoveredWorkload" }, "type": "array" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" } }, "id": "FindUnregisteredWorkloadsResponse" }, "ListDiscoveredWorkloadsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "discoveredWorkloads": { "items": { "$ref": "DiscoveredWorkload" }, "description": "List of Discovered Workloads.", "type": "array" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "description": "Response for ListDiscoveredWorkloads.", "id": "ListDiscoveredWorkloadsResponse" }, "Application": { "id": "Application", "description": "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.", "type": "object", "properties": { "attributes": { "description": "Optional. Consumer provided attributes.", "$ref": "Attributes" }, "name": { "type": "string", "description": "Identifier. The resource name of an Application. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}\"`" }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING" ], "enumDescriptions": [ "Unspecified state.", "The Application is being created.", "The Application is ready to register Services and Workloads.", "The Application is being deleted." ], "type": "string", "description": "Output only. Application state." }, "displayName": { "description": "Optional. User-defined name for the Application. Can have a maximum length of 63 characters.", "type": "string" }, "uid": { "type": "string", "readOnly": true, "description": "Output only. A universally unique identifier (in UUID4 format) for the `Application`." }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Update time.", "type": "string" }, "description": { "description": "Optional. User-defined description of an Application. Can have a maximum length of 2048 characters.", "type": "string" }, "scope": { "$ref": "Scope", "description": "Required. Immutable. Defines what data can be included into this Application. Limits which Services and Workloads can be registered." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Create time." } } }, "LookupServiceProjectAttachmentResponse": { "properties": { "serviceProjectAttachment": { "description": "Service project attachment for a project if exists, empty otherwise.", "$ref": "ServiceProjectAttachment" } }, "id": "LookupServiceProjectAttachmentResponse", "type": "object", "description": "Response for LookupServiceProjectAttachment." }, "ServiceProperties": { "description": "Properties of an underlying cloud resource that can comprise a Service.", "type": "object", "id": "ServiceProperties", "properties": { "functionalType": { "readOnly": true, "description": "Output only. The type of the service.", "$ref": "FunctionalType" }, "identity": { "$ref": "Identity", "description": "Output only. The identity associated with the service.", "readOnly": true }, "extendedMetadata": { "type": "object", "description": "Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}`", "additionalProperties": { "$ref": "ExtendedMetadata" }, "readOnly": true }, "location": { "readOnly": true, "description": "Output only. The location that the underlying resource resides in, for example, us-west1.", "type": "string" }, "zone": { "readOnly": true, "description": "Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).", "type": "string" }, "registrationType": { "description": "Output only. The registration type of the service.", "readOnly": true, "$ref": "RegistrationType" }, "gcpProject": { "description": "Output only. The service project identifier that the underlying cloud resource resides in.", "readOnly": true, "type": "string" } } }, "Identity": { "description": "The identity associated with a service or workload.", "properties": { "principal": { "description": "Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity", "type": "string", "readOnly": true } }, "type": "object", "id": "Identity" }, "DiscoveredWorkload": { "description": "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.", "properties": { "workloadProperties": { "readOnly": true, "$ref": "WorkloadProperties", "description": "Output only. Properties of an underlying compute resource represented by the Workload. These are immutable." }, "name": { "description": "Identifier. The resource name of the discovered workload. Format: `\"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}\"`", "type": "string" }, "workloadReference": { "description": "Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.", "readOnly": true, "$ref": "WorkloadReference" } }, "id": "DiscoveredWorkload", "type": "object" }, "OperationMetadata": { "properties": { "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean", "readOnly": true }, "endTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. The time the operation finished running.", "type": "string" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation was created." }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." } }, "id": "OperationMetadata", "type": "object", "description": "Represents the metadata of the long-running operation." }, "ListExtendedMetadataSchemasResponse": { "description": "Response for ListExtendedMetadataSchemas.", "id": "ListExtendedMetadataSchemasResponse", "type": "object", "properties": { "extendedMetadataSchemas": { "description": "List of Extended Metadata Schemas.", "items": { "$ref": "ExtendedMetadataSchema" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "details": { "type": "array", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "ListWorkloadsResponse": { "id": "ListWorkloadsResponse", "type": "object", "description": "Response for ListWorkloads.", "properties": { "workloads": { "items": { "$ref": "Workload" }, "type": "array", "description": "List of Workloads." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "ServiceReference": { "type": "object", "properties": { "uri": { "readOnly": true, "description": "Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service.", "type": "string" }, "path": { "readOnly": true, "type": "string", "description": "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." } }, "id": "ServiceReference", "description": "Reference to an underlying networking resource that can comprise a Service." }, "ServiceProjectAttachment": { "id": "ServiceProjectAttachment", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state.", "The ServiceProjectAttachment is being created.", "The ServiceProjectAttachment is ready. This means Services and Workloads under the corresponding ServiceProjectAttachment is ready for registration.", "The ServiceProjectAttachment is being deleted." ], "description": "Output only. ServiceProjectAttachment state." }, "uid": { "readOnly": true, "type": "string", "description": "Output only. A globally unique identifier (in UUID4 format) for the `ServiceProjectAttachment`." }, "name": { "type": "string", "description": "Identifier. The resource name of a ServiceProjectAttachment. Format: `\"projects/{host-project-id}/locations/global/serviceProjectAttachments/{service-project-id}.\"`" }, "createTime": { "readOnly": true, "description": "Output only. Create time.", "format": "google-datetime", "type": "string" }, "serviceProject": { "type": "string", "description": "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." } }, "type": "object", "description": "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." }, "Policy": { "type": "object", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "properties": { "etag": { "format": "byte", "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost." }, "auditConfigs": { "items": { "$ref": "AuditConfig" }, "description": "Specifies cloud audit logging configuration for this policy.", "type": "array" }, "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "bindings": { "items": { "$ref": "Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array" } }, "id": "Policy" }, "ListApplicationsResponse": { "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "applications": { "items": { "$ref": "Application" }, "type": "array", "description": "List of Applications." } }, "type": "object", "description": "Response for ListApplications.", "id": "ListApplicationsResponse" }, "ListServicesResponse": { "type": "object", "description": "Response for ListServices.", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "services": { "description": "List of Services.", "items": { "$ref": "Service" }, "type": "array" } }, "id": "ListServicesResponse" }, "RegistrationType": { "description": "The registration type of a service.", "properties": { "type": { "description": "Output only. The registration type of a service.", "type": "string", "readOnly": true, "enumDescriptions": [ "Unspecified registration type. Defaults to EXCLUSIVE.", "The service can only be registered to one application.", "The service can be registered to multiple applications." ], "enum": [ "TYPE_UNSPECIFIED", "EXCLUSIVE", "SHARED" ] } }, "id": "RegistrationType", "type": "object" }, "DiscoveredService": { "properties": { "name": { "description": "Identifier. The resource name of the discovered service. Format: `\"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}\"`", "type": "string" }, "serviceReference": { "readOnly": true, "description": "Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.", "$ref": "ServiceReference" }, "serviceProperties": { "$ref": "ServiceProperties", "description": "Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.", "readOnly": true } }, "description": "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.", "id": "DiscoveredService", "type": "object" }, "DetachServiceProjectAttachmentRequest": { "properties": {}, "description": "Request for DetachServiceProjectAttachment.", "type": "object", "id": "DetachServiceProjectAttachmentRequest" }, "Workload": { "properties": { "workloadProperties": { "$ref": "WorkloadProperties", "readOnly": true, "description": "Output only. Properties of an underlying compute resource represented by the Workload. These are immutable." }, "updateTime": { "description": "Output only. Update time.", "type": "string", "format": "google-datetime", "readOnly": true }, "uid": { "description": "Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.", "type": "string", "readOnly": true }, "displayName": { "description": "Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.", "type": "string" }, "attributes": { "$ref": "Attributes", "description": "Optional. Consumer provided attributes." }, "workloadReference": { "$ref": "WorkloadReference", "readOnly": true, "description": "Output only. Reference of an underlying compute resource represented by the Workload. These are immutable." }, "createTime": { "description": "Output only. Create time.", "readOnly": true, "format": "google-datetime", "type": "string" }, "state": { "enumDescriptions": [ "Unspecified state.", "The Workload is being created.", "The Workload is ready.", "The Workload is being deleted.", "The underlying compute resources have been deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "DETACHED" ], "description": "Output only. Workload state.", "readOnly": true, "type": "string" }, "discoveredWorkload": { "description": "Required. Immutable. The resource name of the original discovered workload.", "type": "string" }, "name": { "description": "Identifier. The resource name of the Workload. Format: `\"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}\"`", "type": "string" }, "description": { "description": "Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.", "type": "string" } }, "type": "object", "id": "Workload", "description": "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." }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "type": "object", "id": "Empty" }, "WorkloadProperties": { "description": "Properties of an underlying compute resource represented by the Workload.", "id": "WorkloadProperties", "properties": { "location": { "readOnly": true, "type": "string", "description": "Output only. The location that the underlying compute resource resides in (for example, us-west1)." }, "extendedMetadata": { "readOnly": true, "additionalProperties": { "$ref": "ExtendedMetadata" }, "type": "object", "description": "Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}`" }, "zone": { "type": "string", "readOnly": true, "description": "Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a)." }, "functionalType": { "description": "Output only. The type of the workload.", "$ref": "FunctionalType", "readOnly": true }, "gcpProject": { "readOnly": true, "type": "string", "description": "Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources." }, "identity": { "$ref": "Identity", "description": "Output only. The identity associated with the workload.", "readOnly": true } }, "type": "object" }, "ExtendedMetadata": { "properties": { "metadataStruct": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Output only. The metadata contents.", "readOnly": true } }, "type": "object", "id": "ExtendedMetadata", "description": "Additional metadata for a Service or Workload." }, "LookupDiscoveredServiceResponse": { "id": "LookupDiscoveredServiceResponse", "type": "object", "description": "Response for LookupDiscoveredService.", "properties": { "discoveredService": { "description": "Discovered Service if exists, empty otherwise.", "$ref": "DiscoveredService" } } }, "ExtendedMetadataSchema": { "description": "ExtendedMetadataSchema represents a schema for extended metadata of a service or workload.", "id": "ExtendedMetadataSchema", "properties": { "name": { "description": "Identifier. Resource name of the schema. Format: projects//locations//extendedMetadataSchemas/", "type": "string" }, "schemaVersion": { "description": "Output only. The version of the schema. New versions are required to be backwards compatible.", "format": "int64", "type": "string", "readOnly": true }, "jsonSchema": { "description": "Output only. The JSON schema as a string.", "readOnly": true, "type": "string" } }, "type": "object" }, "CancelOperationRequest": { "type": "object", "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "FindUnregisteredServicesResponse": { "id": "FindUnregisteredServicesResponse", "properties": { "discoveredServices": { "type": "array", "description": "List of Discovered Services.", "items": { "$ref": "DiscoveredService" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "type": "object", "description": "Response for FindUnregisteredServices." }, "TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } } }, "Channel": { "properties": { "uri": { "description": "Required. URI of the channel.", "type": "string" } }, "id": "Channel", "type": "object", "description": "Separate message to accommodate custom formats across IRC and Slack." }, "Boundary": { "description": "Application management boundary.", "properties": { "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Create time." }, "updateTime": { "readOnly": true, "description": "Output only. Update time.", "type": "string", "format": "google-datetime" }, "name": { "type": "string", "description": "Identifier. The resource name of the boundary. Format: \"projects/{project}/locations/{location}/boundary\"" }, "type": { "enum": [ "TYPE_UNSPECIFIED", "AUTOMATIC", "MANUAL", "MANAGED_AUTOMATIC" ], "type": "string", "readOnly": true, "description": "Output only. Boundary type.", "enumDescriptions": [ "Unspecified type.", "The Boundary automatically includes all descendants of the CRM node.", "The list of projects within the Boundary is managed by the user.", "The Boundary automatically includes all descendants of the CRM node, which is set via App Management folder capability." ] }, "crmNode": { "type": "string", "description": "Optional. The resource name of the CRM node being attached to the boundary. Format: `projects/{project-number}` or `projects/{project-id}`" } }, "type": "object", "id": "Boundary" }, "ListDiscoveredServicesResponse": { "id": "ListDiscoveredServicesResponse", "description": "Response for ListDiscoveredServices.", "type": "object", "properties": { "discoveredServices": { "description": "List of Discovered Services.", "items": { "$ref": "DiscoveredService" }, "type": "array" }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } } }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "type": "object", "id": "Binding", "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" }, "members": { "items": { "type": "string" }, "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array" } } }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" } } }, "id": "TestIamPermissionsRequest", "type": "object" }, "AuditConfig": { "properties": { "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." }, "auditLogConfigs": { "type": "array", "items": { "$ref": "AuditLogConfig" }, "description": "The configuration for logging of each type of permission." } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object", "id": "AuditConfig" } }, "mtlsRootUrl": "https://apphub.mtls.googleapis.com/", "name": "apphub" }