Google Cloud Dataform V1beta1 Client - Class Workspace (0.10.0)

Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class Workspace.

Represents a Dataform Git workspace.

Generated from protobuf message google.cloud.dataform.v1beta1.Workspace

Namespace

Google \ Cloud \ Dataform \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The workspace's name.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp of when the workspace was created.

↳ data_encryption_state DataEncryptionState

Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.

↳ internal_metadata string

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

↳ disable_moves bool

Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.

↳ private_resource_metadata PrivateResourceMetadata

Output only. Metadata indicating whether this resource is user-scoped. For Workspace resources, the user_scoped field is always true.

getName

Identifier. The workspace's name.

Returns
Type Description
string

setName

Identifier. The workspace's name.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp of when the workspace was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp of when the workspace was created.

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

getDataEncryptionState

Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.

Returns
Type Description
DataEncryptionState|null

hasDataEncryptionState

clearDataEncryptionState

setDataEncryptionState

Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.

Parameter
Name Description
var DataEncryptionState
Returns
Type Description
$this

getInternalMetadata

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Returns
Type Description
string

hasInternalMetadata

clearInternalMetadata

setInternalMetadata

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisableMoves

Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.

Returns
Type Description
bool

hasDisableMoves

clearDisableMoves

setDisableMoves

Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPrivateResourceMetadata

Output only. Metadata indicating whether this resource is user-scoped. For Workspace resources, the user_scoped field is always true.

Returns
Type Description
PrivateResourceMetadata|null

hasPrivateResourceMetadata

clearPrivateResourceMetadata

setPrivateResourceMetadata

Output only. Metadata indicating whether this resource is user-scoped. For Workspace resources, the user_scoped field is always true.

Parameter
Name Description
var PrivateResourceMetadata
Returns
Type Description
$this