REST Resource: projects.locations.saas

Resource: Saas

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

JSON representation
{
  "name": string,
  "locations": [
    {
      object (Location)
    }
  ],
  "state": enum (State),
  "conditions": [
    {
      object (SaasCondition)
    }
  ],
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/saas/{saas}"

locations[]

object (Location)

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

state

enum (State)

Output only. State of the Saas. It is always in ACTIVE state if the applicationTemplate is empty.

conditions[]

object (SaasCondition)

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

error

object (Status)

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

labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.

createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Location

Location information that the service is available in.

JSON representation
{
  "name": string
}
Fields
name

string

Optional. Name of location.

State

State of the Saas.

Enums
STATE_TYPE_UNSPECIFIED State type is unspecified.
ACTIVE

Deprecated: Use STATE_ACTIVE.

RUNNING

Deprecated: Use STATE_RUNNING.

FAILED

Deprecated: Use STATE_FAILED.

STATE_ACTIVE The Saas is ready
STATE_RUNNING In the process of importing, synchronizing or replicating ApplicationTemplates
STATE_FAILED Failure during process of importing, synchronizing or replicating ApplicationTemplate processing

SaasCondition

SaasCondition describes the status of a Saas.

JSON representation
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Fields
status

enum (Status)

Required. Status of the condition.

type

enum (Type)

Required. Type of the condition.

lastTransitionTime

string (Timestamp format)

Required. Last time the condition transited from one status to another.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

message

string

Required. Human readable message indicating details about the last transition.

reason

string

Required. Brief reason for the condition's last transition.

Status

Enumeration of condition statuses.

Enums
STATUS_UNSPECIFIED Condition status is unspecified.
STATUS_UNKNOWN Condition is unknown.
STATUS_TRUE Condition is true.
STATUS_FALSE Condition is false.

Type

Enumeration of condition types.

Enums
TYPE_UNSPECIFIED Condition type is unspecified.
TYPE_READY Condition type is ready.
TYPE_SYNCHRONIZED Condition type is synchronized.

Methods

create

Create a new saas.

delete

Delete a single saas.

get

Retrieve a single saas.

list

Retrieve a collection of saas.

patch

Update a single saas.