Interface WorkspaceOrBuilder (0.98.0)

public interface WorkspaceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataEncryptionState()

public abstract DataEncryptionState getDataEncryptionState()

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

.google.cloud.dataform.v1beta1.DataEncryptionState data_encryption_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataEncryptionState

The dataEncryptionState.

getDataEncryptionStateOrBuilder()

public abstract DataEncryptionStateOrBuilder getDataEncryptionStateOrBuilder()

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

.google.cloud.dataform.v1beta1.DataEncryptionState data_encryption_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataEncryptionStateOrBuilder

getDepth()

public abstract int getDepth()

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.

int32 depth = 10 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
int

The depth.

getDisableMoves()

public abstract boolean getDisableMoves()

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

optional bool disable_moves = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableMoves.

getEnableBranchManagement()

public abstract boolean getEnableBranchManagement()

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

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

optional bool enable_branch_management = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

The enableBranchManagement.

getInternalMetadata()

public abstract String 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.

optional string internal_metadata = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The internalMetadata.

getInternalMetadataBytes()

public abstract ByteString getInternalMetadataBytes()

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.

optional string internal_metadata = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for internalMetadata.

getName()

public abstract String getName()

Identifier. The workspace's name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The workspace's name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOriginalBranch()

public abstract String getOriginalBranch()

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.

optional string original_branch = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The originalBranch.

getOriginalBranchBytes()

public abstract ByteString getOriginalBranchBytes()

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.

optional string original_branch = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for originalBranch.

getPrivateResourceMetadata()

public abstract PrivateResourceMetadata getPrivateResourceMetadata()

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

.google.cloud.dataform.v1beta1.PrivateResourceMetadata private_resource_metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateResourceMetadata

The privateResourceMetadata.

getPrivateResourceMetadataOrBuilder()

public abstract PrivateResourceMetadataOrBuilder getPrivateResourceMetadataOrBuilder()

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

.google.cloud.dataform.v1beta1.PrivateResourceMetadata private_resource_metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PrivateResourceMetadataOrBuilder

getShallow()

public abstract boolean getShallow()

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.

optional bool shallow = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The shallow.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataEncryptionState()

public abstract boolean hasDataEncryptionState()

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

.google.cloud.dataform.v1beta1.DataEncryptionState data_encryption_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataEncryptionState field is set.

hasDisableMoves()

public abstract boolean hasDisableMoves()

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

optional bool disable_moves = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the disableMoves field is set.

hasEnableBranchManagement()

public abstract boolean hasEnableBranchManagement()

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

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

optional bool enable_branch_management = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the enableBranchManagement field is set.

hasInternalMetadata()

public abstract boolean hasInternalMetadata()

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.

optional string internal_metadata = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the internalMetadata field is set.

hasOriginalBranch()

public abstract boolean hasOriginalBranch()

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.

optional string original_branch = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the originalBranch field is set.

hasPrivateResourceMetadata()

public abstract boolean hasPrivateResourceMetadata()

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

.google.cloud.dataform.v1beta1.PrivateResourceMetadata private_resource_metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the privateResourceMetadata field is set.

hasShallow()

public abstract boolean hasShallow()

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.

optional bool shallow = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the shallow field is set.