Google Cloud Saas Platform Saas Service Mgmt V1 Client - Class UnitKind (0.1.0)

Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class UnitKind.

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.

Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.UnitKind

Namespace

Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ default_release string

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.

↳ dependencies array<Dependency>

Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.

↳ input_variable_mappings array<VariableMapping>

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.

↳ output_variable_mappings array<VariableMapping>

Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.

↳ saas string

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.

↳ application_template_component ComponentRef

Optional. Reference to component and revision in a composite ApplicationTemplate.

↳ app_params AppParams

Optional. AppParams contains the parameters for creating an AppHub Application.

↳ boundary_type int

Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.

↳ duration_limits DurationLimits

Optional. Defines the default duration limits for UnitOperations created from this UnitKind. These settings provide a baseline for execution time constraints. The limits specified here can be overridden by more specific settings on an individual UnitOperation resource. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout. If not set, UnitOperations will use the system default duration limits unless overridden on the UnitOperation.

↳ labels array|Google\Protobuf\Internal\MapField

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

↳ annotations array|Google\Protobuf\Internal\MapField

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

↳ uid 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.

↳ etag 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.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was created.

↳ update_time Google\Protobuf\Timestamp

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_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDefaultRelease

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.

Returns
Type Description
string

setDefaultRelease

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDependencies

Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found.

Maximum 10.

Returns
Type Description
Google\Protobuf\RepeatedField<Dependency>

setDependencies

Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found.

Maximum 10.

Parameter
Name Description
var array<Dependency>
Returns
Type Description
$this

getInputVariableMappings

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.

Returns
Type Description
Google\Protobuf\RepeatedField<VariableMapping>

setInputVariableMappings

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.

Parameter
Name Description
var array<VariableMapping>
Returns
Type Description
$this

getOutputVariableMappings

Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.

Returns
Type Description
Google\Protobuf\RepeatedField<VariableMapping>

setOutputVariableMappings

Optional. List of outputVariables for this unit kind will be passed to this unit's outputVariables. Maximum 100.

Parameter
Name Description
var array<VariableMapping>
Returns
Type Description
$this

getSaas

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.

Returns
Type Description
string

setSaas

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getApplicationTemplateComponent

Optional. Reference to component and revision in a composite ApplicationTemplate.

Returns
Type Description
ComponentRef|null

hasApplicationTemplateComponent

clearApplicationTemplateComponent

setApplicationTemplateComponent

Optional. Reference to component and revision in a composite ApplicationTemplate.

Parameter
Name Description
var ComponentRef
Returns
Type Description
$this

getAppParams

Optional. AppParams contains the parameters for creating an AppHub Application.

Returns
Type Description
AppParams|null

hasAppParams

clearAppParams

setAppParams

Optional. AppParams contains the parameters for creating an AppHub Application.

Parameter
Name Description
var AppParams
Returns
Type Description
$this

getBoundaryType

Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.

Returns
Type Description
int Enum of type BoundaryType.

setBoundaryType

Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.

Parameter
Name Description
var int

Enum of type BoundaryType.

Returns
Type Description
$this

getDurationLimits

Optional. Defines the default duration limits for UnitOperations created from this UnitKind. These settings provide a baseline for execution time constraints.

The limits specified here can be overridden by more specific settings on an individual UnitOperation resource. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout. If not set, UnitOperations will use the system default duration limits unless overridden on the UnitOperation.

Returns
Type Description
DurationLimits|null

hasDurationLimits

clearDurationLimits

setDurationLimits

Optional. Defines the default duration limits for UnitOperations created from this UnitKind. These settings provide a baseline for execution time constraints.

The limits specified here can be overridden by more specific settings on an individual UnitOperation resource. See the DurationLimits message definition for details on the constraints like minimum, maximum, and system default values for unit_operation_timeout. If not set, UnitOperations will use the system default duration limits unless overridden on the UnitOperation.

Parameter
Name Description
var DurationLimits
Returns
Type Description
$this

getLabels

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

similar to Kubernetes resource labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

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

similar to Kubernetes resource labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getUid

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.

Returns
Type Description
string

setUid

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

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.

Returns
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this