projects

Changed on

Update a single unit.

patch/v1/{+name}

Request

  • Base URL: https://saasservicemgmt.googleapis.com
  • URL: https://saasservicemgmt.googleapis.com/v1/{+name}
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/saasservicemgmt.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/saasservicemgmt.read-write)

Path parameters

namestring required

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"

Query parameters

requestIdstring

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).

updateMaskstring

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.

validateOnlyboolean

If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

Request body

annotationsobject

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

applicationstring

Optional. Reference to the AppHub Application this unit belongs to. All resources deployed in this Unit will be associated with the specified Application.

createTimestring google-datetime

Output only. The timestamp when the resource was created.

etagstring

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.

labelsobject

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

managementMode'MANAGEMENT_MODE_UNSPECIFIED' | 'MANAGEMENT_MODE_USER' | 'MANAGEMENT_MODE_SYSTEM'

Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.

namestring

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"

ongoingOperationsstring[]

Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.

pendingOperationsstring[]

Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.

releasestring

Optional. Output only. The current Release object for this Unit.

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.

scheduledOperationsstring[]

Optional. Output only. List of scheduled UnitOperations for this unit.

state'UNIT_STATE_UNSPECIFIED' | 'UNIT_STATE_NOT_PROVISIONED' | 'UNIT_STATE_PROVISIONING' | 'UNIT_STATE_UPDATING' | 'UNIT_STATE_DEPROVISIONING' | 'UNIT_STATE_READY' | 'UNIT_STATE_ERROR'

Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).

systemCleanupAtstring google-datetime

Optional. Output only. If set, indicates the time when the system will start removing the unit.

systemManagedState'SYSTEM_MANAGED_STATE_UNSPECIFIED' | 'SYSTEM_MANAGED_STATE_ACTIVE' | 'SYSTEM_MANAGED_STATE_INACTIVE' | 'SYSTEM_MANAGED_STATE_DECOMMISSIONED'

Optional. Output only. Indicates the system managed state of the unit.

tenantstring

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)

uidstring

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.

unitKindstring

Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.

updateTimestring google-datetime

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.

Response

Successful response

Changes

  • 2091ebefd113Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/saasservicemgmt.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/saasservicemgmt.read-write was removed from the endpoint's security scheme Oauth2c

  • a960b62d2056Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      api operation id saasservicemgmt.projects.locations.unitOperations.patch removed and replaced with saasservicemgmt.projects.locations.units.patch

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/saasservicemgmt.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/saasservicemgmt.read-write was removed from the endpoint's security scheme Oauth2c