Dataform v1beta1 API - Class Workspace (1.0.0-beta14)

public sealed class Workspace : IMessage<Workspace>, IEquatable<Workspace>, IDeepCloneable<Workspace>, IBufferMessage, IMessage

Reference documentation and code samples for the Dataform v1beta1 API class Workspace.

Represents a Dataform Git workspace.

Inheritance

object > Workspace

Namespace

Google.Cloud.Dataform.V1Beta1

Assembly

Google.Cloud.Dataform.V1Beta1.dll

Constructors

Workspace()

public Workspace()

Workspace(Workspace)

public Workspace(Workspace other)
Parameter
Name Description
other Workspace

Properties

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DataEncryptionState

public DataEncryptionState DataEncryptionState { get; set; }

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

Property Value
Type Description
DataEncryptionState

Depth

public int Depth { get; set; }

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.

Property Value
Type Description
int

DisableMoves

public bool DisableMoves { get; set; }

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

Property Value
Type Description
bool

EnableBranchManagement

public bool EnableBranchManagement { get; set; }

Immutable. Controls the enablement of branch checkout for the workspace.

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

Property Value
Type Description
bool

HasDisableMoves

public bool HasDisableMoves { get; }

Gets whether the "disable_moves" field is set

Property Value
Type Description
bool

HasEnableBranchManagement

public bool HasEnableBranchManagement { get; }

Gets whether the "enable_branch_management" field is set

Property Value
Type Description
bool

HasInternalMetadata

public bool HasInternalMetadata { get; }

Gets whether the "internal_metadata" field is set

Property Value
Type Description
bool

HasOriginalBranch

public bool HasOriginalBranch { get; }

Gets whether the "original_branch" field is set

Property Value
Type Description
bool

HasShallow

public bool HasShallow { get; }

Gets whether the "shallow" field is set

Property Value
Type Description
bool

InternalMetadata

public string InternalMetadata { get; set; }

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.

Property Value
Type Description
string

Name

public string Name { get; set; }

Identifier. The workspace's name.

Property Value
Type Description
string

OriginalBranch

public string OriginalBranch { get; set; }

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.

Property Value
Type Description
string

PrivateResourceMetadata

public PrivateResourceMetadata PrivateResourceMetadata { get; set; }

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

Property Value
Type Description
PrivateResourceMetadata

Shallow

public bool Shallow { get; set; }

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.

Property Value
Type Description
bool

WorkspaceName

public WorkspaceName WorkspaceName { get; set; }

WorkspaceName-typed view over the Name resource name property.

Property Value
Type Description
WorkspaceName