{ "rootUrl": "https://saasservicemgmt.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "kind": "discovery#restDescription", "title": "App Lifecycle Manager API", "version": "v1", "ownerName": "Google", "documentationLink": "https://cloud.google.com/saas-runtime/docs", "mtlsRootUrl": "https://saasservicemgmt.mtls.googleapis.com/", "parameters": { "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "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" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ] }, "alt": { "default": "json", "location": "query", "type": "string", "description": "Data format for response.", "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" ] }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "quotaUser": { "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.", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" } }, "fullyEncodeReservedExpansion": true, "resources": { "projects": { "resources": { "locations": { "resources": { "units": { "methods": { "create": { "request": { "$ref": "Unit" }, "id": "saasservicemgmt.projects.locations.units.create", "response": { "$ref": "Unit" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+parent}/units", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent of the unit.", "location": "path", "required": true }, "unitId": { "type": "string", "description": "Required. The ID value for the new unit.", "location": "query" }, "validateOnly": { "type": "boolean", "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." }, "requestId": { "location": "query", "description": "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" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/units", "description": "Create a new unit." }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", "parameters": { "requestId": { "type": "string", "location": "query", "description": "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)." }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the resource within a service." }, "etag": { "location": "query", "description": "The etag known to the client for the expected state of the unit. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "type": "string" }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, "id": "saasservicemgmt.projects.locations.units.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Delete a single unit.", "httpMethod": "DELETE", "response": { "$ref": "Empty" } }, "patch": { "response": { "$ref": "Unit" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "request": { "$ref": "Unit" }, "path": "v1/{+name}", "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Field mask is used to specify the fields to be overwritten in the Unit 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 in the Unit will be overwritten.", "location": "query", "type": "string" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/units/{unit}\"", "required": true, "location": "path" }, "requestId": { "type": "string", "location": "query", "description": "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)." }, "validateOnly": { "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean" } }, "id": "saasservicemgmt.projects.locations.units.patch", "description": "Update a single unit.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}" }, "get": { "response": { "$ref": "Unit" }, "parameterOrder": [ "name" ], "id": "saasservicemgmt.projects.locations.units.get", "parameters": { "name": { "description": "Required. The resource name of the resource within a service.", "pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "description": "Retrieve a single unit.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "path": "v1/{+name}" }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "ListUnitsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/units", "description": "Retrieve a collection of units.", "id": "saasservicemgmt.projects.locations.units.list", "parameters": { "parent": { "type": "string", "description": "Required. The parent of the unit.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of units to send per page.", "format": "int32" }, "orderBy": { "location": "query", "type": "string", "description": "Order results as specified in https://google.aip.dev/132." }, "pageToken": { "location": "query", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Filter the list as specified in https://google.aip.dev/160." } }, "path": "v1/{+parent}/units" } } }, "rollouts": { "methods": { "get": { "response": { "$ref": "Rollout" }, "parameters": { "name": { "description": "Required. The resource name of the resource within a service.", "pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "description": "Retrieve a single rollout.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "id": "saasservicemgmt.projects.locations.rollouts.get", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}" }, "list": { "response": { "$ref": "ListRolloutsResponse" }, "id": "saasservicemgmt.projects.locations.rollouts.list", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/rollouts", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page." }, "orderBy": { "type": "string", "description": "Order results as specified in https://google.aip.dev/132.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The parent of the rollout." }, "pageSize": { "type": "integer", "description": "The maximum number of rollouts to send per page.", "format": "int32", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Filter the list as specified in https://google.aip.dev/160." } }, "description": "Retrieve a collection of rollouts.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rollouts" }, "patch": { "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollout/{rollout_id}\"", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the Rollout 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 in the Rollout will be overwritten." }, "requestId": { "description": "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" }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, "id": "saasservicemgmt.projects.locations.rollouts.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "response": { "$ref": "Rollout" }, "parameterOrder": [ "name" ], "request": { "$ref": "Rollout" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", "description": "Update a single rollout.", "path": "v1/{+name}", "httpMethod": "PATCH" }, "create": { "id": "saasservicemgmt.projects.locations.rollouts.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rollouts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "parameters": { "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean", "location": "query" }, "rolloutId": { "location": "query", "description": "Required. The ID value for the new rollout.", "type": "string" }, "parent": { "location": "path", "description": "Required. The parent of the rollout.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "requestId": { "description": "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" } }, "response": { "$ref": "Rollout" }, "description": "Create a new rollout.", "path": "v1/{+parent}/rollouts", "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "Rollout" } }, "delete": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", "description": "Delete a single rollout.", "httpMethod": "DELETE", "id": "saasservicemgmt.projects.locations.rollouts.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "parameters": { "validateOnly": { "location": "query", "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." }, "etag": { "type": "string", "description": "The etag known to the client for the expected state of the rollout. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query" }, "requestId": { "type": "string", "description": "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": { "description": "Required. The resource name of the resource within a service.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$" } } } } }, "tenants": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tenants", "parameterOrder": [ "parent" ], "id": "saasservicemgmt.projects.locations.tenants.list", "path": "v1/{+parent}/tenants", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "parameters": { "filter": { "type": "string", "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query" }, "orderBy": { "description": "Order results as specified in https://google.aip.dev/132.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "type": "string" }, "parent": { "location": "path", "description": "Required. The parent of the tenant.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of tenants to send per page.", "location": "query" } }, "httpMethod": "GET", "description": "Retrieve a collection of tenants.", "response": { "$ref": "ListTenantsResponse" } }, "patch": { "httpMethod": "PATCH", "request": { "$ref": "Tenant" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+name}", "id": "saasservicemgmt.projects.locations.tenants.patch", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/tenants/{tenant}\"", "required": true }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the Tenant 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 in the Tenant will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" }, "requestId": { "type": "string", "location": "query", "description": "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)." } }, "response": { "$ref": "Tenant" }, "description": "Update a single tenant." }, "create": { "parameterOrder": [ "parent" ], "id": "saasservicemgmt.projects.locations.tenants.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tenants", "httpMethod": "POST", "description": "Create a new tenant.", "response": { "$ref": "Tenant" }, "path": "v1/{+parent}/tenants", "parameters": { "validateOnly": { "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query" }, "tenantId": { "type": "string", "location": "query", "description": "Required. The ID value for the new tenant." }, "parent": { "required": true, "location": "path", "description": "Required. The parent of the tenant.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "requestId": { "description": "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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "request": { "$ref": "Tenant" } }, "delete": { "description": "Delete a single tenant.", "id": "saasservicemgmt.projects.locations.tenants.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "validateOnly": { "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean" }, "etag": { "location": "query", "description": "The etag known to the client for the expected state of the tenant. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the tenant. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "type": "string" }, "name": { "type": "string", "description": "Required. The resource name of the resource within a service.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$" }, "requestId": { "description": "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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "response": { "$ref": "Empty" } }, "get": { "description": "Retrieve a single tenant.", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", "required": true, "description": "Required. The resource name of the resource within a service." } }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", "id": "saasservicemgmt.projects.locations.tenants.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "response": { "$ref": "Tenant" }, "httpMethod": "GET" } } }, "rolloutKinds": { "methods": { "create": { "description": "Create a new rollout kind.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "RolloutKind" }, "id": "saasservicemgmt.projects.locations.rolloutKinds.create", "request": { "$ref": "RolloutKind" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", "parameters": { "validateOnly": { "type": "boolean", "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." }, "requestId": { "description": "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": { "required": true, "location": "path", "description": "Required. The parent of the rollout kind.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "rolloutKindId": { "description": "Required. The ID value for the new rollout kind.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+parent}/rolloutKinds" }, "delete": { "id": "saasservicemgmt.projects.locations.rolloutKinds.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The resource name of the resource within a service." }, "requestId": { "type": "string", "description": "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" }, "etag": { "description": "The etag known to the client for the expected state of the rollout kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "type": "string", "location": "query" }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean", "location": "query" } }, "response": { "$ref": "Empty" }, "description": "Delete a single rollout kind.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "RolloutKind" }, "path": "v1/{+name}", "id": "saasservicemgmt.projects.locations.rolloutKinds.get", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Required. The resource name of the resource within a service.", "pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "description": "Retrieve a single rollout kind." }, "patch": { "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "RolloutKind" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "id": "saasservicemgmt.projects.locations.rolloutKinds.patch", "parameterOrder": [ "name" ], "description": "Update a single rollout kind.", "request": { "$ref": "RolloutKind" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", "required": true, "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}\"", "type": "string" }, "updateMask": { "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the RolloutKind 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 in the RolloutKind will be overwritten.", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "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" }, "validateOnly": { "location": "query", "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ] }, "list": { "parameters": { "pageSize": { "location": "query", "description": "The maximum number of rollout kinds to send per page.", "type": "integer", "format": "int32" }, "filter": { "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" }, "parent": { "required": true, "location": "path", "description": "Required. The parent of the rollout kind.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page." }, "orderBy": { "location": "query", "description": "Order results as specified in https://google.aip.dev/132.", "type": "string" } }, "description": "Retrieve a collection of rollout kinds.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", "path": "v1/{+parent}/rolloutKinds", "id": "saasservicemgmt.projects.locations.rolloutKinds.list", "response": { "$ref": "ListRolloutKindsResponse" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "httpMethod": "GET" } } }, "releases": { "methods": { "create": { "parameters": { "releaseId": { "location": "query", "description": "Required. The ID value for the new release.", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "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)." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent of the release.", "required": true, "type": "string" }, "validateOnly": { "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query" } }, "request": { "$ref": "Release" }, "path": "v1/{+parent}/releases", "response": { "$ref": "Release" }, "description": "Create a new release.", "id": "saasservicemgmt.projects.locations.releases.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/releases", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "parameterOrder": [ "parent" ] }, "delete": { "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "description": "Delete a single release.", "httpMethod": "DELETE", "path": "v1/{+name}", "parameters": { "etag": { "description": "The etag known to the client for the expected state of the release. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the release. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "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)." }, "name": { "required": true, "location": "path", "description": "Required. The resource name of the resource within a service.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$" }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "id": "saasservicemgmt.projects.locations.releases.delete" }, "patch": { "parameterOrder": [ "name" ], "id": "saasservicemgmt.projects.locations.releases.patch", "parameters": { "requestId": { "location": "query", "description": "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" }, "validateOnly": { "location": "query", "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." }, "updateMask": { "location": "query", "type": "string", "description": "Field mask is used to specify the fields to be overwritten in the Release 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 in the Release will be overwritten.", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", "location": "path", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/releases/{release}\"", "required": true, "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "description": "Update a single release.", "request": { "$ref": "Release" }, "response": { "$ref": "Release" }, "httpMethod": "PATCH", "path": "v1/{+name}" }, "get": { "id": "saasservicemgmt.projects.locations.releases.get", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", "description": "Required. The resource name of the resource within a service.", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "description": "Retrieve a single release.", "httpMethod": "GET", "response": { "$ref": "Release" } }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/releases", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "httpMethod": "GET", "path": "v1/{+parent}/releases", "parameterOrder": [ "parent" ], "id": "saasservicemgmt.projects.locations.releases.list", "parameters": { "orderBy": { "type": "string", "description": "Order results as specified in https://google.aip.dev/132.", "location": "query" }, "parent": { "description": "Required. The parent of the release.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "type": "string", "location": "query" }, "pageSize": { "description": "The maximum number of releases to send per page.", "format": "int32", "location": "query", "type": "integer" }, "filter": { "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" } }, "description": "Retrieve a collection of releases.", "response": { "$ref": "ListReleasesResponse" } } } }, "unitOperations": { "methods": { "create": { "httpMethod": "POST", "path": "v1/{+parent}/unitOperations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitOperations", "id": "saasservicemgmt.projects.locations.unitOperations.create", "request": { "$ref": "UnitOperation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "description": "Create a new unit operation.", "response": { "$ref": "UnitOperation" }, "parameters": { "unitOperationId": { "location": "query", "description": "Required. The ID value for the new unit operation.", "type": "string" }, "validateOnly": { "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean" }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the unit operation.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "requestId": { "description": "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": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", "type": "string", "description": "Required. The resource name of the resource within a service.", "location": "path", "required": true }, "etag": { "type": "string", "description": "The etag known to the client for the expected state of the unit operation. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit operation. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query" }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" }, "requestId": { "location": "query", "description": "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" } }, "id": "saasservicemgmt.projects.locations.unitOperations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", "description": "Delete a single unit operation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "description": "Retrieve a single unit operation.", "id": "saasservicemgmt.projects.locations.unitOperations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the resource within a service.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", "type": "string" } }, "response": { "$ref": "UnitOperation" }, "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "patch": { "response": { "$ref": "UnitOperation" }, "httpMethod": "PATCH", "description": "Update a single unit operation.", "path": "v1/{+name}", "id": "saasservicemgmt.projects.locations.unitOperations.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", "parameterOrder": [ "name" ], "request": { "$ref": "UnitOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "parameters": { "requestId": { "location": "query", "type": "string", "description": "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)." }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean", "location": "query" }, "name": { "required": true, "location": "path", "type": "string", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitOperations/{unitOperation}\"", "pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$" }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the UnitOperation 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 in the UnitOperation will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" } } }, "list": { "parameters": { "filter": { "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of unit operations to send per page.", "location": "query" }, "pageToken": { "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "type": "string", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The parent of the unit operation.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "orderBy": { "description": "Order results as specified in https://google.aip.dev/132.", "type": "string", "location": "query" } }, "id": "saasservicemgmt.projects.locations.unitOperations.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitOperations", "parameterOrder": [ "parent" ], "response": { "$ref": "ListUnitOperationsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/unitOperations", "description": "Retrieve a collection of unit operations." } } }, "unitKinds": { "methods": { "list": { "path": "v1/{+parent}/unitKinds", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListUnitKindsResponse" }, "description": "Retrieve a collection of unit kinds.", "id": "saasservicemgmt.projects.locations.unitKinds.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitKinds", "parameters": { "filter": { "type": "string", "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query" }, "orderBy": { "location": "query", "description": "Order results as specified in https://google.aip.dev/132.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page." }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent of the unit kind.", "required": true, "location": "path" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The maximum number of unit kinds to send per page." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", "request": { "$ref": "UnitKind" }, "parameters": { "requestId": { "description": "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" }, "validateOnly": { "type": "boolean", "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes." }, "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitKinds/{unitKind}\"", "pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Field mask is used to specify the fields to be overwritten in the UnitKind 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 in the UnitKind will be overwritten." } }, "httpMethod": "PATCH", "path": "v1/{+name}", "id": "saasservicemgmt.projects.locations.unitKinds.patch", "parameterOrder": [ "name" ], "response": { "$ref": "UnitKind" }, "description": "Update a single unit kind." }, "create": { "response": { "$ref": "UnitKind" }, "parameters": { "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" }, "unitKindId": { "description": "Required. The ID value for the new unit kind.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent of the unit kind." }, "requestId": { "location": "query", "description": "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" } }, "path": "v1/{+parent}/unitKinds", "request": { "$ref": "UnitKind" }, "description": "Create a new unit kind.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "id": "saasservicemgmt.projects.locations.unitKinds.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitKinds" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", "description": "Delete a single unit kind.", "parameterOrder": [ "name" ], "parameters": { "validateOnly": { "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean" }, "etag": { "description": "The etag known to the client for the expected state of the unit kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "type": "string", "location": "query" }, "requestId": { "description": "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" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", "location": "path", "description": "Required. The resource name of the resource within a service.", "required": true, "type": "string" } }, "path": "v1/{+name}", "id": "saasservicemgmt.projects.locations.unitKinds.delete", "response": { "$ref": "Empty" } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", "type": "string", "description": "Required. The resource name of the resource within a service.", "location": "path", "required": true } }, "response": { "$ref": "UnitKind" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "path": "v1/{+name}", "description": "Retrieve a single unit kind.", "id": "saasservicemgmt.projects.locations.unitKinds.get" } } }, "saas": { "methods": { "get": { "response": { "$ref": "Saas" }, "parameters": { "name": { "required": true, "location": "path", "description": "Required. The resource name of the resource within a service.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$" } }, "path": "v1/{+name}", "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.saas.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "description": "Retrieve a single saas.", "parameterOrder": [ "name" ] }, "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the saas.", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Order results as specified in https://google.aip.dev/132." }, "pageToken": { "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of saas to send per page.", "location": "query" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/saas", "description": "Retrieve a collection of saas.", "id": "saasservicemgmt.projects.locations.saas.list", "response": { "$ref": "ListSaasResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write", "https://www.googleapis.com/auth/saasservicemgmt.readonly" ], "path": "v1/{+parent}/saas", "parameterOrder": [ "parent" ] }, "create": { "id": "saasservicemgmt.projects.locations.saas.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/saas", "description": "Create a new saas.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "saasId": { "type": "string", "location": "query", "description": "Required. The ID value for the new saas." }, "requestId": { "location": "query", "description": "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" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The parent of the saas." }, "validateOnly": { "type": "boolean", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query" } }, "response": { "$ref": "Saas" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "path": "v1/{+parent}/saas", "request": { "$ref": "Saas" } }, "delete": { "parameterOrder": [ "name" ], "description": "Delete a single saas.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "response": { "$ref": "Empty" }, "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The resource name of the resource within a service.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", "required": true, "location": "path" }, "etag": { "description": "The etag known to the client for the expected state of the saas. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the saas. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "type": "string", "location": "query" }, "requestId": { "type": "string", "location": "query", "description": "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)." }, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean", "location": "query" } }, "id": "saasservicemgmt.projects.locations.saas.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", "path": "v1/{+name}", "httpMethod": "PATCH", "description": "Update a single saas.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/saasservicemgmt.read-write" ], "request": { "$ref": "Saas" }, "id": "saasservicemgmt.projects.locations.saas.patch", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", "type": "string", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", "required": true, "location": "path" }, "requestId": { "location": "query", "type": "string", "description": "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)." }, "validateOnly": { "location": "query", "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "type": "boolean" }, "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the Saas 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 in the Saas will be overwritten." } }, "response": { "$ref": "Saas" } } } } }, "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "description": "Gets information about a location.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Resource name for the location." } }, "path": "v1/{+name}", "response": { "$ref": "GoogleCloudLocationLocation" }, "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.get", "parameterOrder": [ "name" ] }, "list": { "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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)." }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer", "location": "query", "format": "int32" }, "extraLocationTypes": { "type": "string", "location": "query", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." }, "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "saasservicemgmt.projects.locations.list", "response": { "$ref": "ListLocationsResponse" } } } } } } }, "ownerDomain": "google.com", "name": "saasservicemgmt", "version_module": true, "protocol": "rest", "discoveryVersion": "v1", "description": "Model, deploy, and operate your SaaS at scale. ", "basePath": "", "batchPath": "batch", "baseUrl": "https://saasservicemgmt.googleapis.com/", "canonicalName": "SaaS Service Management", "revision": "20261005", "id": "saasservicemgmt:v1", "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." }, "https://www.googleapis.com/auth/saasservicemgmt.read-write": { "description": "See, edit, configure, and delete your Google Cloud App Lifecycle Management data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/saasservicemgmt.readonly": { "description": "See your Google Cloud App Lifecycle Management data and the email address of your Google Account" } } } }, "servicePath": "", "schemas": { "Upgrade": { "properties": { "inputVariables": { "items": { "$ref": "UnitVariable" }, "description": "Optional. Set of input variables. Maximum 100. (optional)", "type": "array" }, "release": { "type": "string", "description": "Optional. Reference to the Release object to use for the Unit. (optional)." } }, "type": "object", "id": "Upgrade", "description": "Upgrade is the unit operation that upgrades a provisioned unit, which may also include the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned." }, "ErrorBudget": { "id": "ErrorBudget", "type": "object", "description": "The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.", "properties": { "allowedPercentage": { "description": "Optional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.", "type": "integer", "format": "int32" }, "allowedCount": { "type": "integer", "description": "Optional. The maximum number of failed units allowed in a location without pausing the rollout.", "format": "int32" } } }, "RolloutControl": { "type": "object", "properties": { "action": { "description": "Required. Action to be performed on the Rollout. The default behavior is to run the rollout until it naturally reaches a terminal state.", "type": "string", "enum": [ "ROLLOUT_ACTION_UNSPECIFIED", "ROLLOUT_ACTION_RUN", "ROLLOUT_ACTION_PAUSE", "ROLLOUT_ACTION_CANCEL" ], "enumDescriptions": [ "Unspecified action, will be treated as RUN by default.", "Run the Rollout until it naturally reaches a terminal state. A rollout requested to run will progress through all natural Rollout States (such as RUNNING -\u003e SUCCEEDED or RUNNING -\u003e FAILED). If retriable errors are encountered during the rollout, the rollout will paused by default and can be resumed by re-requesting this RUN action.", "Pause the Rollout until it is resumed (i.e. RUN is requested).", "Cancel the Rollout permanently." ] }, "runParams": { "description": "Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.", "$ref": "RunRolloutActionParams" } }, "id": "RolloutControl", "description": "RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it." }, "ListRolloutsResponse": { "id": "ListRolloutsResponse", "description": "The response structure for the ListRollouts method.", "type": "object", "properties": { "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "rollouts": { "type": "array", "items": { "$ref": "Rollout" }, "description": "The resulting rollouts." }, "nextPageToken": { "type": "string", "description": "If present, the next page token can be provided to a subsequent ListRollouts call to list the next page. If empty, there are no more pages." } } }, "CompositeRef": { "properties": { "syncOperation": { "description": "Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage.", "type": "string", "readOnly": true }, "revision": { "type": "string", "description": "Optional. Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored." }, "applicationTemplate": { "type": "string", "description": "Required. Reference to the ApplicationTemplate resource." } }, "id": "CompositeRef", "type": "object", "description": "CompositeRef represents a reference to a composite resource." }, "MaintenanceSettings": { "description": "Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.", "properties": { "pinnedUntilTime": { "description": "Optional. If present, it fixes the release on the unit until the given time; i.e. changes to the release field will be rejected. Rollouts should and will also respect this by not requesting an upgrade in the first place.", "format": "google-datetime", "type": "string" } }, "type": "object", "id": "MaintenanceSettings" }, "Release": { "id": "Release", "properties": { "releaseRequirements": { "$ref": "ReleaseRequirements", "description": "Optional. Set of requirements to be fulfilled on the Unit when using this Release." }, "blueprint": { "description": "Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.", "$ref": "Blueprint" }, "etag": { "readOnly": true, "type": "string", "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written." }, "inputVariables": { "type": "array", "items": { "$ref": "UnitVariable" }, "description": "Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec", "readOnly": true }, "unitKind": { "description": "Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels." }, "uid": { "readOnly": true, "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "type": "string" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations" }, "applicationTemplateComponent": { "readOnly": true, "description": "Output only. Reference to component and revision in a composite ApplicationTemplate.", "$ref": "ComponentRef" }, "inputVariableDefaults": { "items": { "$ref": "UnitVariable" }, "description": "Optional. Mapping of input variables to default values. Maximum 100", "type": "array" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value." }, "name": { "type": "string", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/releases/{release}\"" }, "outputVariables": { "readOnly": true, "description": "Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status", "items": { "$ref": "UnitVariable" }, "type": "array" } }, "description": "A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation via Artifact Registry.", "type": "object" }, "Empty": { "id": "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" }, "Provision": { "properties": { "inputVariables": { "type": "array", "items": { "$ref": "UnitVariable" }, "description": "Optional. Set of input variables. Maximum 100. (optional)" }, "release": { "description": "Optional. Reference to the Release object to use for the Unit. (optional).", "type": "string" } }, "id": "Provision", "description": "Provision is the unit operation that provision the underlying resources represented by a Unit. Can only execute if the Unit is not currently provisioned.", "type": "object" }, "Location": { "id": "Location", "type": "object", "description": "Location information that the service is available in.", "properties": { "name": { "type": "string", "description": "Optional. Name of location." } } }, "ReleaseRequirements": { "id": "ReleaseRequirements", "description": "Set of requirements to be fulfilled on the Unit when using this Release.", "properties": { "upgradeableFromReleases": { "description": "Optional. A list of releases from which a unit can be upgraded to this one (optional). If left empty no constraints will be applied. When provided, unit upgrade requests to this release will check and enforce this constraint.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "UnitOperation": { "type": "object", "properties": { "engineState": { "description": "Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.", "readOnly": true, "type": "string" }, "cancel": { "type": "boolean", "description": "Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)" }, "deprovision": { "description": "Optional. Deprovision operation.", "$ref": "Deprovision" }, "name": { "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitOperations/{unitOperation}\"", "type": "string" }, "conditions": { "description": "Optional. Output only. A set of conditions which indicate the various conditions this resource can have.", "readOnly": true, "type": "array", "items": { "$ref": "UnitOperationCondition" } }, "deleteTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation)." }, "rollout": { "description": "Optional. Specifies which rollout created this Unit Operation. This cannot be modified and is used for filtering purposes only. If a dependent unit and unit operation are created as part of another unit operation, they will use the same rolloutId.", "type": "string" }, "upgrade": { "description": "Optional. Upgrade operation.", "$ref": "Upgrade" }, "labels": { "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "type": "object", "additionalProperties": { "type": "string" } }, "uid": { "type": "string", "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true }, "errorCategory": { "description": "Optional. Output only. UnitOperationErrorCategory describe the error category.", "type": "string", "readOnly": true, "enumDescriptions": [ "Unit operation error category is unspecified", "Unit operation error category is not applicable, or it is not an error", "Unit operation error category is fatal", "Unit operation error category is retriable", "Unit operation error category is ignorable", "Unit operation error category is standard, counts towards Rollout error budget" ], "enum": [ "UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED", "NOT_APPLICABLE", "FATAL", "RETRIABLE", "IGNORABLE", "STANDARD" ] }, "provision": { "$ref": "Provision", "description": "Optional. Provision operation." }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value." }, "etag": { "type": "string", "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "readOnly": true }, "parentUnitOperation": { "description": "Optional. Reference to parent resource: UnitOperation. If an operation needs to create other operations as part of its workflow, each of the child operations should have this field set to the parent. This can be used for tracing. (Optional)", "type": "string" }, "schedule": { "description": "Optional. When to schedule this operation.", "$ref": "Schedule" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime" }, "state": { "readOnly": true, "enumDescriptions": [ "Unit operation state is unknown.", "Unit operation is accepted but not ready to run.", "Unit operation is accepted and scheduled.", "Unit operation is running.", "Unit operation has completed successfully.", "Unit operation has failed.", "Unit operation was cancelled." ], "enum": [ "UNIT_OPERATION_STATE_UNKNOWN", "UNIT_OPERATION_STATE_PENDING", "UNIT_OPERATION_STATE_SCHEDULED", "UNIT_OPERATION_STATE_RUNNING", "UNIT_OPERATION_STATE_SUCCEEDED", "UNIT_OPERATION_STATE_FAILED", "UNIT_OPERATION_STATE_CANCELLED" ], "description": "Optional. Output only. UnitOperationState describes the current state of the unit operation.", "type": "string" }, "unit": { "description": "Required. Immutable. The Unit a given UnitOperation will act upon.", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object" } }, "description": "UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations). UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested. This is a base object that contains the common fields in all unit operations. Next: 22", "id": "UnitOperation" }, "RolloutKind": { "type": "object", "description": "An object that describes various settings of Rollout execution. Includes built-in and customizable policies.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The timestamp when the resource was created.", "readOnly": true, "type": "string" }, "etag": { "readOnly": true, "type": "string", "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written." }, "unitUpdatePacing": { "description": "Optional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region.", "$ref": "UnitUpdatePacing" }, "uid": { "type": "string", "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true }, "unitKind": { "description": "Optional. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value." }, "errorBudget": { "description": "Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.", "$ref": "ErrorBudget" }, "updateUnitKindStrategy": { "type": "string", "enum": [ "UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED", "UPDATE_UNIT_KIND_STRATEGY_ON_START", "UPDATE_UNIT_KIND_STRATEGY_NEVER" ], "description": "Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.", "enumDescriptions": [ "Strategy unspecified.", "Update the unit kind strategy on the rollout start.", "Never update the unit kind." ] }, "labels": { "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "annotations": { "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object", "additionalProperties": { "type": "string" } }, "rolloutOrchestrationStrategy": { "description": "Optional. The strategy used for executing a Rollout. This is a required field. There are two supported values strategies which are used to control - \"Google.Cloud.Simple.AllAtOnce\" - \"Google.Cloud.Simple.OneLocationAtATime\" A rollout with one of these simple strategies will rollout across all locations defined in the associated UnitKind's Saas Locations.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}\"" }, "unitFilter": { "description": "Optional. [CEL](https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout.", "type": "string" } }, "id": "RolloutKind" }, "ListTenantsResponse": { "properties": { "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent ListTenants call to list the next page. If empty, there are no more pages.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "tenants": { "type": "array", "items": { "$ref": "Tenant" }, "description": "The resulting tenants." } }, "type": "object", "description": "The response structure for the ListTenants method.", "id": "ListTenantsResponse" }, "Tenant": { "type": "object", "description": "Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: \"projects/svc1/locations/loc/tenants/inst-068afff8\" consumer_resource: \"projects/gshoe/locations/loc/shoes/black-shoe\"", "id": "Tenant", "properties": { "saas": { "type": "string", "description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model." }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "type": "string" }, "uid": { "type": "string", "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels." }, "name": { "type": "string", "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/tenants/{tenant}\"" }, "etag": { "type": "string", "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "readOnly": true }, "consumerResource": { "description": "Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", "type": "string", "format": "google-datetime" } } }, "ListUnitKindsResponse": { "type": "object", "id": "ListUnitKindsResponse", "description": "The response structure for the ListUnitKinds method.", "properties": { "nextPageToken": { "type": "string", "description": "If present, the next page token can be provided to a subsequent ListUnitKinds call to list the next page. If empty, there are no more pages." }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "unitKinds": { "type": "array", "items": { "$ref": "UnitKind" }, "description": "The resulting unit kinds." } } }, "RolloutStats": { "id": "RolloutStats", "properties": { "operationsByState": { "readOnly": true, "description": "Optional. Output only. Unordered list. A breakdown of the progress of operations triggered by the rollout. Provides a count of Operations by their state. This can be used to determine the number of units which have been updated, or are scheduled to be updated. There will be at most one entry per group. Possible values for operation groups are: - \"SCHEDULED\" - \"PENDING\" - \"RUNNING\" - \"SUCCEEDED\" - \"FAILED\" - \"CANCELLED\"", "type": "array", "items": { "$ref": "Aggregate" } }, "estimatedTotalUnitCount": { "description": "Optional. Output only. Estimated number of units based. The estimation is computed upon creation of the rollout.", "type": "string", "readOnly": true, "format": "int64" } }, "type": "object", "description": "RolloutStats contains information about the progress of a rollout." }, "Status": { "properties": { "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." }, "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" }, "details": { "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.", "type": "array" } }, "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).", "type": "object" }, "ListUnitOperationsResponse": { "id": "ListUnitOperationsResponse", "description": "The response structure for the ListUnitOperations method.", "type": "object", "properties": { "unitOperations": { "items": { "$ref": "UnitOperation" }, "type": "array", "description": "The resulting unit operations." }, "nextPageToken": { "type": "string", "description": "If present, the next page token can be provided to a subsequent ListUnitOperations call to list the next page. If empty, there are no more pages." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } } }, "GoogleCloudLocationLocation": { "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "type": "object", "properties": { "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." } } }, "Decimal": { "id": "Decimal", "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).", "properties": { "value": { "description": "The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits (\"the integer\"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -\u003e `2.5`). - Replacing a zero-length integer value with `0` (`.5` -\u003e `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -\u003e `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -\u003e `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` \u003c-\u003e `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.", "type": "string" } }, "type": "object" }, "Blueprint": { "description": "Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (Terraform, for example) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev).", "type": "object", "id": "Blueprint", "properties": { "engine": { "readOnly": true, "description": "Output only. Type of the engine used to actuate the blueprint. (Terraform, for example)", "type": "string" }, "package": { "description": "Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set).", "type": "string" }, "version": { "type": "string", "readOnly": true, "description": "Output only. Version metadata if present on the blueprint." } } }, "Schedule": { "description": "A time specification to schedule the maintenance.", "id": "Schedule", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Optional. Start of operation. If not set, will be set to the start of the next window. (optional)" } }, "type": "object" }, "ListRolloutKindsResponse": { "id": "ListRolloutKindsResponse", "properties": { "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent ListRolloutKinds call to list the next page. If empty, there are no more pages.", "type": "string" }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } }, "rolloutKinds": { "items": { "$ref": "RolloutKind" }, "description": "The resulting rollout kinds.", "type": "array" } }, "description": "The response structure for the ListRolloutKinds method.", "type": "object" }, "Dependency": { "description": "Dependency represent a single dependency with another unit kind by alias.", "type": "object", "id": "Dependency", "properties": { "unitKind": { "description": "Required. Immutable. The unit kind of the dependency.", "type": "string" }, "alias": { "description": "Required. An alias for the dependency. Used for input variable mapping.", "type": "string" } } }, "Unit": { "properties": { "systemManagedState": { "enum": [ "SYSTEM_MANAGED_STATE_UNSPECIFIED", "SYSTEM_MANAGED_STATE_ACTIVE", "SYSTEM_MANAGED_STATE_INACTIVE", "SYSTEM_MANAGED_STATE_DECOMMISSIONED" ], "readOnly": true, "enumDescriptions": [ "Unspecified system managed state.", "Unit has dependents attached.", "Unit has no dependencies attached, but attachment is allowed.", "Unit has no dependencies attached, and attachment is not allowed." ], "type": "string", "description": "Optional. Output only. Indicates the system managed state of the unit." }, "systemCleanupAt": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Optional. Output only. If set, indicates the time when the system will start removing the unit." }, "release": { "description": "Optional. Output only. The current Release object for this Unit.", "readOnly": true, "type": "string" }, "managementMode": { "enumDescriptions": [ "Unspecified management mode.", "Unit's lifecycle is managed by the user.", "The system will decide when to deprovision and delete the unit. User still can deprovision or delete the unit manually." ], "description": "Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.", "type": "string", "enum": [ "MANAGEMENT_MODE_UNSPECIFIED", "MANAGEMENT_MODE_USER", "MANAGEMENT_MODE_SYSTEM" ] }, "state": { "enum": [ "UNIT_STATE_UNSPECIFIED", "UNIT_STATE_NOT_PROVISIONED", "UNIT_STATE_PROVISIONING", "UNIT_STATE_UPDATING", "UNIT_STATE_DEPROVISIONING", "UNIT_STATE_READY", "UNIT_STATE_ERROR" ], "enumDescriptions": [ "Unspecified state.", "Unit is not provisioned.", "Unit is being provisioned.", "Unit is being updated. This is typically when a unit is being upgraded to a new release or some of the input variables on the Unit is being changed. Certain kinds of updates may cause the Unit to become unusable while the update is in progress.", "Unit is being deleted.", "Unit has been provisioned and is ready for use", "Unit has error, when it is not ready and some error operation" ], "type": "string", "readOnly": true, "description": "Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use)." }, "labels": { "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "type": "object", "additionalProperties": { "type": "string" } }, "pendingOperations": { "readOnly": true, "description": "Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.", "items": { "type": "string" }, "type": "array" }, "scheduledOperations": { "type": "array", "items": { "type": "string" }, "description": "Optional. Output only. List of scheduled UnitOperations for this unit.", "readOnly": true }, "outputVariables": { "items": { "$ref": "UnitVariable" }, "type": "array", "readOnly": true, "description": "Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (in Terraform for example) and the values are fetched and returned by the actuation engine upon completion of execution." }, "ongoingOperations": { "readOnly": true, "type": "array", "description": "Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.", "items": { "type": "string" } }, "dependents": { "description": "Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.", "readOnly": true, "type": "array", "items": { "$ref": "UnitDependency" } }, "unitKind": { "type": "string", "description": "Optional. Reference to the UnitKind this Unit belongs to. Immutable once set." }, "uid": { "readOnly": true, "type": "string", "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4." }, "inputVariables": { "readOnly": true, "description": "Optional. Output only. Indicates the current input variables deployed by the unit", "items": { "$ref": "UnitVariable" }, "type": "array" }, "conditions": { "readOnly": true, "description": "Optional. Output only. A set of conditions which indicate the various conditions this resource can have.", "items": { "$ref": "UnitCondition" }, "type": "array" }, "annotations": { "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "type": "object", "additionalProperties": { "type": "string" } }, "tenant": { "description": "Optional. Reference to the Saas Tenant resource this unit belongs to. This for example informs the maintenance policies to use for scheduling future updates on a unit. (optional and immutable once created)", "type": "string" }, "createTime": { "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "satisfiesPzs": { "description": "Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.", "type": "boolean", "readOnly": true }, "etag": { "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", "readOnly": true, "type": "string" }, "application": { "description": "Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application.", "type": "string" }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "maintenance": { "description": "Optional. Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.", "$ref": "MaintenanceSettings" }, "name": { "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/units/{unit}\"", "type": "string" }, "dependencies": { "items": { "$ref": "UnitDependency" }, "type": "array", "readOnly": true, "description": "Optional. Output only. Set of dependencies for this unit. Maximum 10." } }, "description": "A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, or a custom implementation provided by a service producer). A building block of a SaaS Tenant.", "type": "object", "id": "Unit" }, "ListUnitsResponse": { "type": "object", "properties": { "units": { "description": "The resulting units.", "items": { "$ref": "Unit" }, "type": "array" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent ListUnits call to list the next page. If empty, there are no more pages.", "type": "string" } }, "id": "ListUnitsResponse", "description": "The response structure for the ListUnits method." }, "UnitCondition": { "id": "UnitCondition", "description": "UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.", "type": "object", "properties": { "message": { "type": "string", "description": "Required. Human readable message indicating details about the last transition." }, "status": { "type": "string", "enum": [ "STATUS_UNSPECIFIED", "STATUS_UNKNOWN", "STATUS_TRUE", "STATUS_FALSE" ], "description": "Required. Status of the condition.", "enumDescriptions": [ "Condition status is unspecified.", "Condition is unknown.", "Condition is true.", "Condition is false." ] }, "reason": { "type": "string", "description": "Required. Brief reason for the condition's last transition." }, "lastTransitionTime": { "format": "google-datetime", "description": "Required. Last time the condition transited from one status to another.", "type": "string" }, "type": { "description": "Required. Type of the condition.", "enumDescriptions": [ "Condition type is unspecified.", "Condition type is ready.", "Condition type is updating.", "Condition type is provisioned.", "Condition type is operationError. True when the last unit operation fails with a non-ignorable error.", "Condition type is flagsConfigInitialized. True when the flags configuration is synchronized and ready to be served.", "Indicates if AppHub app has been created or if Apphub app has already existed.", "Indicates if services and workloads have been registered with AppHub." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_READY", "TYPE_UPDATING", "TYPE_PROVISIONED", "TYPE_OPERATION_ERROR", "TYPE_FLAGS_CONFIG_INITIALIZED", "TYPE_APP_CREATED_OR_ALREADY_EXISTS", "TYPE_APP_COMPONENTS_REGISTERED" ] } } }, "ComponentRef": { "id": "ComponentRef", "description": "ComponentRef represents a reference to a component resource.", "type": "object", "properties": { "revision": { "type": "string", "description": "Optional. Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate." }, "component": { "description": "Optional. Name of the component in composite.Components", "type": "string" }, "compositeRef": { "description": "Optional. Reference to the Composite ApplicationTemplate.", "$ref": "CompositeRef" } } }, "FromMapping": { "type": "object", "properties": { "outputVariable": { "description": "Required. Name of the outputVariable on the dependency", "type": "string" }, "dependency": { "type": "string", "description": "Required. Alias of the dependency that the outputVariable will pass its value to" } }, "id": "FromMapping", "description": "Output variables whose values will be passed on to dependencies" }, "ListReleasesResponse": { "type": "object", "id": "ListReleasesResponse", "description": "The response structure for the ListReleases method.", "properties": { "releases": { "type": "array", "description": "The resulting releases.", "items": { "$ref": "Release" } }, "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent ListReleases call to list the next page. If empty, there are no more pages.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } } }, "VariableMapping": { "description": "Mapping of input variables to their respective output variable for depedenencies", "type": "object", "id": "VariableMapping", "properties": { "variable": { "type": "string", "description": "Required. name of the variable" }, "to": { "description": "Optional. Input variables whose values will be passed on to dependencies.", "$ref": "ToMapping" }, "from": { "description": "Optional. Output variables which will get their values from dependencies", "$ref": "FromMapping" } } }, "Saas": { "type": "object", "id": "Saas", "description": "Saas is a representation of a SaaS service managed by the Producer.", "properties": { "locations": { "items": { "$ref": "Location" }, "description": "Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.", "type": "array" }, "name": { "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations" }, "state": { "type": "string", "enumDescriptions": [ "State is unspecified.", "State type is unspecified. Deprecated: Use STATE_UNSPECIFIED instead.", "The Saas is ready", "In the process of importing, synchronizing or replicating ApplicationTemplates", "Failure during process of importing, synchronizing or replicating ApplicationTemplate processing" ], "description": "Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty.", "enumDeprecated": [ false, true, false, false, false ], "enum": [ "STATE_UNSPECIFIED", "STATE_TYPE_UNSPECIFIED", "STATE_ACTIVE", "STATE_RUNNING", "STATE_FAILED" ], "readOnly": true }, "conditions": { "type": "array", "description": "Output only. A set of conditions which indicate the various conditions this resource can have.", "readOnly": true, "items": { "$ref": "SaasCondition" } }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp when the resource was created.", "type": "string" }, "uid": { "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "type": "string", "readOnly": true }, "labels": { "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "error": { "readOnly": true, "$ref": "Status", "description": "Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states." }, "etag": { "type": "string", "readOnly": true, "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written." }, "updateTime": { "readOnly": true, "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", "type": "string", "format": "google-datetime" }, "blueprintRepo": { "description": "Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates.", "readOnly": true, "type": "string" }, "applicationTemplate": { "description": "Optional. Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions.", "$ref": "CompositeRef" } } }, "SaasCondition": { "description": "SaasCondition describes the status of a Saas.", "properties": { "status": { "type": "string", "enum": [ "STATUS_UNSPECIFIED", "STATUS_UNKNOWN", "STATUS_TRUE", "STATUS_FALSE" ], "description": "Required. Status of the condition.", "enumDescriptions": [ "Condition status is unspecified.", "Condition is unknown.", "Condition is true.", "Condition is false." ] }, "reason": { "type": "string", "description": "Required. Brief reason for the condition's last transition." }, "message": { "type": "string", "description": "Required. Human readable message indicating details about the last transition." }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_READY", "TYPE_SYNCHRONIZED" ], "enumDescriptions": [ "Condition type is unspecified.", "Condition type is ready.", "Condition type is synchronized." ], "description": "Required. Type of the condition." }, "lastTransitionTime": { "type": "string", "description": "Required. Last time the condition transited from one status to another.", "format": "google-datetime" } }, "id": "SaasCondition", "type": "object" }, "Aggregate": { "description": "Represents the aggregation of a set of population of like records by a certain group. For example, a collection of unit counts can be aggregated and grouped by their state.", "id": "Aggregate", "type": "object", "properties": { "group": { "description": "Required. Group by which to aggregate.", "type": "string" }, "count": { "description": "Required. Number of records in the group.", "type": "integer", "format": "int32" } } }, "UnitVariable": { "type": "object", "description": "UnitVariable describes a parameter for a Unit.", "id": "UnitVariable", "properties": { "variable": { "type": "string", "description": "Required. Immutable. Name of the variable from actuation configs." }, "value": { "type": "string", "description": "Optional. String encoded value for the variable." }, "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INT", "BOOL", "STRUCT", "LIST" ], "description": "Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.", "enumDescriptions": [ "Variable type is unspecified.", "Variable type is string.", "Variable type is int.", "Variable type is bool.", "Variable type is struct.", "Variable type is list." ] } } }, "UnitUpdatePacing": { "id": "UnitUpdatePacing", "description": "UnitUpdatePacing defines the policy for the maximum number of unit operations that can run for a rollout in parallel in a single region.", "properties": { "maxConcurrentOperationsCount": { "type": "integer", "format": "int32", "description": "Optional. An absolute cap on concurrent units operations. If both percent and count are provided, the system uses the MINIMUM (most restrictive)." }, "maxConcurrentOperationsPercent": { "$ref": "Decimal", "description": "Optional. The maximum percentage of total units in the scope that can be in-flight. Example: 10.5 for 10.5%. If both percent and count are provided, the system uses the MINIMUM (most restrictive)." } }, "type": "object" }, "UnitKind": { "id": "UnitKind", "properties": { "uid": { "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "readOnly": true, "type": "string" }, "appParams": { "$ref": "AppParams", "description": "Optional. AppParams contains the parameters for creating an AppHub Application." }, "inputVariableMappings": { "type": "array", "description": "Optional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.", "items": { "$ref": "VariableMapping" } }, "name": { "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitKinds/{unitKind}\"", "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value." }, "applicationTemplateComponent": { "$ref": "ComponentRef", "description": "Optional. Reference to component and revision in a composite ApplicationTemplate." }, "outputVariableMappings": { "type": "array", "items": { "$ref": "VariableMapping" }, "description": "Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100." }, "createTime": { "format": "google-datetime", "description": "Output only. The timestamp when the resource was created.", "type": "string", "readOnly": true }, "labels": { "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "dependencies": { "items": { "$ref": "Dependency" }, "description": "Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.", "type": "array" }, "deleteTime": { "format": "google-datetime", "type": "string", "description": "Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).", "readOnly": true }, "saas": { "type": "string", "description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set." }, "defaultRelease": { "description": "Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.", "type": "string" }, "boundaryType": { "description": "Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.", "type": "string", "readOnly": true, "enum": [ "BOUNDARY_TYPE_UNSPECIFIED", "BOUNDARY_TYPE_TENANT_PROJECT", "BOUNDARY_TYPE_MANAGED_PROJECT" ], "enumDescriptions": [ "Unspecified boundary type.", "Tenant project boundary.", "Managed project boundary." ] }, "annotations": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations" }, "etag": { "readOnly": true, "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "type": "string" } }, "type": "object", "description": "Definition of a Unit. Units belonging to the same UnitKind are managed together; for example they follow the same release model (blueprints, versions etc.) and are typically rolled out together." }, "ListSaasResponse": { "properties": { "saas": { "type": "array", "description": "The resulting saas.", "items": { "$ref": "Saas" } }, "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent ListSaas call to list the next page. If empty, there are no more pages.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "type": "object", "id": "ListSaasResponse", "description": "The response structure for the ListSaas method." }, "RunRolloutActionParams": { "description": "Parameters for the RUN action controlling the behavior of the rollout when it is resumed from a PAUSED state.", "type": "object", "id": "RunRolloutActionParams", "properties": { "retryFailedOperations": { "type": "boolean", "description": "Required. If true, the rollout will retry failed operations when resumed. This is applicable only the current state of the Rollout is PAUSED and the requested action is RUN." } } }, "Deprovision": { "description": "Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.", "id": "Deprovision", "properties": {}, "type": "object" }, "Scope": { "properties": { "type": { "enumDescriptions": [ "Unspecified type.", "Regional type.", "Global type." ], "description": "Required. Scope Type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_REGIONAL", "TYPE_GLOBAL" ] } }, "id": "Scope", "description": "Scope of an application.", "type": "object" }, "ToMapping": { "type": "object", "properties": { "inputVariable": { "description": "Required. Name of the inputVariable on the dependency", "type": "string" }, "ignoreForLookup": { "type": "boolean", "description": "Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not" }, "dependency": { "type": "string", "description": "Required. Alias of the dependency that the inputVariable will pass its value to" } }, "description": "Input variables whose values will be passed on to dependencies", "id": "ToMapping" }, "Rollout": { "properties": { "parentRollout": { "readOnly": true, "type": "string", "description": "Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollouts/{rollout_id}\"" }, "state": { "enumDescriptions": [ "Unspecified state.", "Rollout is in progress.", "Rollout has been paused.", "Rollout completed successfully.", "Rollout has failed.", "Rollout has been canceled.", "Rollout is waiting for some condition to be met before starting.", "Rollout is being canceled.", "Rollout is being resumed.", "Rollout is being paused." ], "description": "Output only. Current state of the rollout.", "enum": [ "ROLLOUT_STATE_UNSPECIFIED", "ROLLOUT_STATE_RUNNING", "ROLLOUT_STATE_PAUSED", "ROLLOUT_STATE_SUCCEEDED", "ROLLOUT_STATE_FAILED", "ROLLOUT_STATE_CANCELLED", "ROLLOUT_STATE_WAITING", "ROLLOUT_STATE_CANCELLING", "ROLLOUT_STATE_RESUMING", "ROLLOUT_STATE_PAUSING" ], "readOnly": true, "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp when the resource was created.", "format": "google-datetime", "type": "string" }, "release": { "type": "string", "description": "Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified." }, "startTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet." }, "updateTime": { "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", "format": "google-datetime", "readOnly": true, "type": "string" }, "effectiveUnitFilter": { "description": "Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.", "type": "string", "readOnly": true }, "rolloutKind": { "description": "Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.", "type": "string" }, "etag": { "type": "string", "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", "readOnly": true }, "uid": { "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", "type": "string", "readOnly": true }, "name": { "description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollout/{rollout_id}\"", "type": "string" }, "stateMessage": { "readOnly": true, "type": "string", "description": "Output only. Human readable message indicating details about the last state transition." }, "endTime": { "readOnly": true, "type": "string", "description": "Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.", "format": "google-datetime" }, "stats": { "readOnly": true, "$ref": "RolloutStats", "description": "Optional. Output only. Details about the progress of the rollout." }, "rootRollout": { "type": "string", "description": "Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollouts/{rollout_id}\"", "readOnly": true }, "labels": { "type": "object", "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "additionalProperties": { "type": "string" } }, "control": { "description": "Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -\u003e SUCCEEDED or RUNNING -\u003e FAILED). Requests can only be made when the Rollout is in a non-terminal state.", "$ref": "RolloutControl" }, "unitFilter": { "type": "string", "description": "Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used." }, "deleteTime": { "description": "Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).", "format": "google-datetime", "type": "string", "readOnly": true }, "rolloutOrchestrationStrategy": { "type": "string", "description": "Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - \"Google.Cloud.Simple.AllAtOnce\" - \"Google.Cloud.Simple.OneLocationAtATime\" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations." }, "annotations": { "type": "object", "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "additionalProperties": { "type": "string" } }, "stateTransitionTime": { "readOnly": true, "format": "google-datetime", "description": "Optional. Output only. The time when the rollout transitioned into its current state.", "type": "string" } }, "description": "Represents a single rollout execution and its results", "id": "Rollout", "type": "object" }, "UnitOperationCondition": { "description": "UnitOperationCondition describes the status of an Unit Operation. UnitOperationCondition is individual components that contribute to an overall state.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_SCHEDULED", "TYPE_RUNNING", "TYPE_SUCCEEDED", "TYPE_CANCELLED", "TYPE_APP_CREATED", "TYPE_APP_COMPONENTS_REGISTERED", "TYPE_WORKLOAD_SUCCEEDED" ], "enumDescriptions": [ "Condition type is unspecified.", "Condition type is scheduled.", "Condition type is running.", "Condition type is succeeded.", "Condition type is cancelled.", "Indicates if AppHub app has been created.", "Indicates if services and workloads have been registered with AppHub.", "Indicates if the UnitOperation's core workload execution completed successfully. The workload is the core execution operation performed for a UnitOperation (e.g., provisioning, updating, or deprovisioning resources) excluding post-operation checks." ], "description": "Required. Type of the condition." }, "lastTransitionTime": { "description": "Required. Last time the condition transited from one status to another.", "type": "string", "format": "google-datetime" }, "status": { "type": "string", "enum": [ "STATUS_UNSPECIFIED", "STATUS_UNKNOWN", "STATUS_TRUE", "STATUS_FALSE" ], "enumDescriptions": [ "Condition status is unspecified.", "Condition is unknown.", "Condition is true.", "Condition is false." ], "description": "Required. Status of the condition." }, "reason": { "description": "Required. Brief reason for the condition's last transition.", "type": "string" }, "message": { "description": "Required. Human readable message indicating details about the last transition.", "type": "string" } }, "id": "UnitOperationCondition" }, "AppParams": { "id": "AppParams", "properties": { "group": { "type": "string", "description": "Optional. Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name" }, "scope": { "description": "Optional. Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL.", "$ref": "Scope" } }, "description": "AppParams contains the parameters for creating an AppHub Application.", "type": "object" }, "UnitDependency": { "description": "Set of dependencies for this unit. Maximum 10.", "id": "UnitDependency", "type": "object", "properties": { "unit": { "type": "string", "description": "Output only. A reference to the Unit object.", "readOnly": true }, "alias": { "type": "string", "readOnly": true, "description": "Output only. Alias for the name of the dependency." } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "type": "array", "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudLocationLocation" } } }, "type": "object" } } }