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

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

Saas is a representation of a SaaS service managed by the Producer.

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

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

↳ locations array<Location>

Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.

↳ application_template CompositeRef

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.

↳ blueprint_repo string

Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates.

↳ state int

Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty.

↳ conditions array<SaasCondition>

Output only. A set of conditions which indicate the various conditions this resource can have.

↳ error Google\Rpc\Status

Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.

↳ 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}/saas/{saas}"

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLocations

Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.

Returns
Type Description
Google\Protobuf\RepeatedField<Location>

setLocations

Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.

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

getApplicationTemplate

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.

Returns
Type Description
CompositeRef|null

hasApplicationTemplate

clearApplicationTemplate

setApplicationTemplate

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.

Parameter
Name Description
var CompositeRef
Returns
Type Description
$this

getBlueprintRepo

Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates.

Returns
Type Description
string

setBlueprintRepo

Output only. Name of repository in Artifact Registry for system-generated Blueprints, eg. Blueprints of imported ApplicationTemplates.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. State of the Saas.

It is always in STATE_ACTIVE state if the application_template is empty.

Returns
Type Description
int Enum of type State.

setState

Output only. State of the Saas.

It is always in STATE_ACTIVE state if the application_template is empty.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getConditions

Output only. A set of conditions which indicate the various conditions this resource can have.

Returns
Type Description
Google\Protobuf\RepeatedField<SaasCondition>

setConditions

Output only. A set of conditions which indicate the various conditions this resource can have.

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

getError

Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.

Parameter
Name Description
var Google\Rpc\Status
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