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

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

A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation via Artifact Registry.

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

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}/releases/{release}"

↳ unit_kind string

Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).

↳ blueprint Blueprint

Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.

↳ release_requirements Release\ReleaseRequirements

Optional. Set of requirements to be fulfilled on the Unit when using this Release.

↳ input_variables array<UnitVariable>

Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec

↳ output_variables array<UnitVariable>

Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status

↳ input_variable_defaults array<UnitVariable>

Optional. Mapping of input variables to default values. Maximum 100

↳ application_template_component ComponentRef

Output only. Reference to component and revision in a composite ApplicationTemplate.

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

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getUnitKind

Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).

Returns
Type Description
string

setUnitKind

Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).

Parameter
Name Description
var string
Returns
Type Description
$this

getBlueprint

Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.

Returns
Type Description
Blueprint|null

hasBlueprint

clearBlueprint

setBlueprint

Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.

Parameter
Name Description
var Blueprint
Returns
Type Description
$this

getReleaseRequirements

Optional. Set of requirements to be fulfilled on the Unit when using this Release.

Returns
Type Description
Release\ReleaseRequirements|null

hasReleaseRequirements

clearReleaseRequirements

setReleaseRequirements

Optional. Set of requirements to be fulfilled on the Unit when using this Release.

Parameter
Name Description
var Release\ReleaseRequirements
Returns
Type Description
$this

getInputVariables

Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec

Returns
Type Description
Google\Protobuf\RepeatedField<UnitVariable>

setInputVariables

Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec

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

getOutputVariables

Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status

Returns
Type Description
Google\Protobuf\RepeatedField<UnitVariable>

setOutputVariables

Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status

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

getInputVariableDefaults

Optional. Mapping of input variables to default values. Maximum 100

Returns
Type Description
Google\Protobuf\RepeatedField<UnitVariable>

setInputVariableDefaults

Optional. Mapping of input variables to default values. Maximum 100

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

getApplicationTemplateComponent

Output only. Reference to component and revision in a composite ApplicationTemplate.

Returns
Type Description
ComponentRef|null

hasApplicationTemplateComponent

clearApplicationTemplateComponent

setApplicationTemplateComponent

Output only. Reference to component and revision in a composite ApplicationTemplate.

Parameter
Name Description
var ComponentRef
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