Class Workspace (0.98.0)

public final class Workspace extends GeneratedMessage implements WorkspaceOrBuilder

Represents a Dataform Git workspace.

Protobuf type google.cloud.dataform.v1beta1.Workspace

Implements

WorkspaceOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_ENCRYPTION_STATE_FIELD_NUMBER

public static final int DATA_ENCRYPTION_STATE_FIELD_NUMBER
Field Value
Type Description
int

DEPTH_FIELD_NUMBER

public static final int DEPTH_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_MOVES_FIELD_NUMBER

public static final int DISABLE_MOVES_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_BRANCH_MANAGEMENT_FIELD_NUMBER

public static final int ENABLE_BRANCH_MANAGEMENT_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_METADATA_FIELD_NUMBER

public static final int INTERNAL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORIGINAL_BRANCH_FIELD_NUMBER

public static final int ORIGINAL_BRANCH_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_RESOURCE_METADATA_FIELD_NUMBER

public static final int PRIVATE_RESOURCE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

SHALLOW_FIELD_NUMBER

public static final int SHALLOW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Workspace getDefaultInstance()
Returns
Type Description
Workspace

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Workspace.Builder newBuilder()
Returns
Type Description
Workspace.Builder

newBuilder(Workspace prototype)

public static Workspace.Builder newBuilder(Workspace prototype)
Parameter
Name Description
prototype Workspace
Returns
Type Description
Workspace.Builder

parseDelimitedFrom(InputStream input)

public static Workspace parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Workspace parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Workspace parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Workspace parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Workspace parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Workspace parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Workspace parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Workspace parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Workspace parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Workspace parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Workspace parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Workspace parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Workspace
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Workspace> parser()
Returns
Type Description
Parser<Workspace>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public 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 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 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 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

getDefaultInstanceForType()

public Workspace getDefaultInstanceForType()
Returns
Type Description
Workspace

getDepth()

public 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 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 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 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 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 String getName()

Identifier. The workspace's name.

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

Returns
Type Description
String

The name.

getNameBytes()

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

getParserForType()

public Parser<Workspace> getParserForType()
Returns
Type Description
Parser<Workspace>
Overrides

getPrivateResourceMetadata()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShallow()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Workspace.Builder newBuilderForType()
Returns
Type Description
Workspace.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Workspace.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Workspace.Builder
Overrides

toBuilder()

public Workspace.Builder toBuilder()
Returns
Type Description
Workspace.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException