Dataform V1beta1 API - Class Google::Cloud::Dataform::V1beta1::Workspace (v1.3.0)

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

Represents a Dataform Git workspace.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_encryption_state

def data_encryption_state() -> ::Google::Cloud::Dataform::V1beta1::DataEncryptionState
Returns

#depth

def depth() -> ::Integer
Returns
  • (::Integer) — Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.

#depth=

def depth=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.
Returns
  • (::Integer) — Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.

#disable_moves

def disable_moves() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.

#disable_moves=

def disable_moves=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.
Returns
  • (::Boolean) — Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.

#enable_branch_management

def enable_branch_management() -> ::Boolean
Returns
  • (::Boolean) — Immutable. Controls the enablement of branch checkout for the workspace.

    When set to True, the workspace will be allowed to checkout branches.

#enable_branch_management=

def enable_branch_management=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Immutable. Controls the enablement of branch checkout for the workspace.

    When set to True, the workspace will be allowed to checkout branches.

Returns
  • (::Boolean) — Immutable. Controls the enablement of branch checkout for the workspace.

    When set to True, the workspace will be allowed to checkout branches.

#internal_metadata

def internal_metadata() -> ::String
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The workspace's name.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The workspace's name.
Returns
  • (::String) — Identifier. The workspace's name.

#original_branch

def original_branch() -> ::String
Returns
  • (::String) — Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used.

#original_branch=

def original_branch=(value) -> ::String
Parameter
  • value (::String) — Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used.
Returns
  • (::String) — Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used.

#private_resource_metadata

def private_resource_metadata() -> ::Google::Cloud::Dataform::V1beta1::PrivateResourceMetadata
Returns

#shallow

def shallow() -> ::Boolean
Returns
  • (::Boolean) — Output only. If set to true, the workspace was created as a shallow clone. Will be set to true if the depth field is set to a value greater than 0, otherwise it will be set to false.