Close httplib2 connections.
create(parent, body=None, requestId=None, unitId=None, validateOnly=None, x__xgafv=None)
Create a new unit.
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Delete a single unit.
Retrieve a single unit.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Retrieve a collection of units.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update a single unit.
close()
Close httplib2 connections.
create(parent, body=None, requestId=None, unitId=None, validateOnly=None, x__xgafv=None)
Create a new unit.
Args:
parent: string, Required. The parent of the unit. (required)
body: object, The request body.
The object takes the form of:
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
}
requestId: string, 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).
unitId: string, Required. The ID value for the new unit.
validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
}
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Delete a single unit.
Args:
name: string, Required. The resource name of the resource within a service. (required)
etag: string, 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.
requestId: string, 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: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}
get(name, x__xgafv=None)
Retrieve a single unit.
Args:
name: string, Required. The resource name of the resource within a service. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Retrieve a collection of units.
Args:
parent: string, Required. The parent of the unit. (required)
filter: string, Filter the list as specified in https://google.aip.dev/160.
orderBy: string, Order results as specified in https://google.aip.dev/132.
pageSize: integer, The maximum number of units to send per page.
pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response structure for the ListUnits method.
"nextPageToken": "A String", # 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.
"units": [ # The resulting units.
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update a single unit.
Args:
name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}" (required)
body: object, The request body.
The object takes the form of:
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
}
requestId: string, 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).
updateMask: string, 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.
validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.
"annotations": { # 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
"a_key": "A String",
},
"conditions": [ # Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
{ # UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
"lastTransitionTime": "A String", # Required. Last time the condition transited from one status to another.
"message": "A String", # Required. Human readable message indicating details about the last transition.
"reason": "A String", # Required. Brief reason for the condition's last transition.
"status": "A String", # Required. Status of the condition.
"type": "A String", # Required. Type of the condition.
},
],
"createTime": "A String", # Output only. The timestamp when the resource was created.
"dependencies": [ # Optional. Output only. Set of dependencies for this unit. Maximum 10.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"dependents": [ # Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
{ # Set of dependencies for this unit. Maximum 10.
"alias": "A String", # Output only. Alias for the name of the dependency.
"unit": "A String", # Output only. A reference to the Unit object.
},
],
"etag": "A String", # 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": [ # Optional. Output only. Indicates the current input variables deployed by the unit
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
"a_key": "A String",
},
"maintenance": { # 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. # 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.
"pinnedUntilTime": "A String", # 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.
},
"managementMode": "A String", # Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
"name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/units/{unit}"
"ongoingOperations": [ # Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
"A String",
],
"outputVariables": [ # Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
{ # UnitVariable describes a parameter for a Unit.
"type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool.
"value": "A String", # Optional. String encoded value for the variable.
"variable": "A String", # Required. Immutable. Name of the variable from actuation configs.
},
],
"pendingOperations": [ # Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
"A String",
],
"release": "A String", # Optional. Output only. The current Release object for this Unit.
"scheduledOperations": [ # Optional. Output only. List of scheduled UnitOperations for this unit.
"A String",
],
"state": "A String", # Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
"systemCleanupAt": "A String", # Optional. Output only. If set, indicates the time when the system will start removing the unit.
"systemManagedState": "A String", # Optional. Output only. Indicates the system managed state of the unit.
"tenant": "A String", # 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)
"uid": "A String", # 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.
"unitKind": "A String", # Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
"updateTime": "A String", # 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.
}