Class ConversionWorkspace (2.45.0)

public final class ConversionWorkspace extends GeneratedMessageV3 implements ConversionWorkspaceOrBuilder

The main conversion workspace resource entity.

Protobuf type google.cloud.clouddms.v1.ConversionWorkspace

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GLOBAL_SETTINGS_FIELD_NUMBER

public static final int GLOBAL_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

HAS_UNCOMMITTED_CHANGES_FIELD_NUMBER

public static final int HAS_UNCOMMITTED_CHANGES_FIELD_NUMBER
Field Value
Type Description
int

LATEST_COMMIT_ID_FIELD_NUMBER

public static final int LATEST_COMMIT_ID_FIELD_NUMBER
Field Value
Type Description
int

LATEST_COMMIT_TIME_FIELD_NUMBER

public static final int LATEST_COMMIT_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversionWorkspace getDefaultInstance()
Returns
Type Description
ConversionWorkspace

getDescriptor()

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

newBuilder()

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

newBuilder(ConversionWorkspace prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsGlobalSettings(String key)

public boolean containsGlobalSettings(String key)

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

map<string, string> global_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

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 when the workspace resource was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ConversionWorkspace getDefaultInstanceForType()
Returns
Type Description
ConversionWorkspace

getDestination()

public DatabaseEngineInfo getDestination()

Required. The destination engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo destination = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseEngineInfo

The destination.

getDestinationOrBuilder()

public DatabaseEngineInfoOrBuilder getDestinationOrBuilder()

Required. The destination engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo destination = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseEngineInfoOrBuilder

getDisplayName()

public String getDisplayName()

Optional. The display name for the workspace.

string display_name = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name for the workspace.

string display_name = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getGlobalSettings() (deprecated)

public Map<String,String> getGlobalSettings()
Returns
Type Description
Map<String,String>

getGlobalSettingsCount()

public int getGlobalSettingsCount()

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

map<string, string> global_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getGlobalSettingsMap()

public Map<String,String> getGlobalSettingsMap()

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

map<string, string> global_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getGlobalSettingsOrDefault(String key, String defaultValue)

public String getGlobalSettingsOrDefault(String key, String defaultValue)

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

map<string, string> global_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getGlobalSettingsOrThrow(String key)

public String getGlobalSettingsOrThrow(String key)

Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true

map<string, string> global_settings = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getHasUncommittedChanges()

public boolean getHasUncommittedChanges()

Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).

bool has_uncommitted_changes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The hasUncommittedChanges.

getLatestCommitId()

public String getLatestCommitId()

Output only. The latest commit ID.

string latest_commit_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The latestCommitId.

getLatestCommitIdBytes()

public ByteString getLatestCommitIdBytes()

Output only. The latest commit ID.

string latest_commit_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for latestCommitId.

getLatestCommitTime()

public Timestamp getLatestCommitTime()

Output only. The timestamp when the workspace was committed.

.google.protobuf.Timestamp latest_commit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The latestCommitTime.

getLatestCommitTimeOrBuilder()

public TimestampOrBuilder getLatestCommitTimeOrBuilder()

Output only. The timestamp when the workspace was committed.

.google.protobuf.Timestamp latest_commit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSource()

public DatabaseEngineInfo getSource()

Required. The source engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo source = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseEngineInfo

The source.

getSourceOrBuilder()

public DatabaseEngineInfoOrBuilder getSourceOrBuilder()

Required. The source engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo source = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseEngineInfoOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the workspace resource was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the workspace resource was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

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

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDestination()

public boolean hasDestination()

Required. The destination engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo destination = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the destination field is set.

hasLatestCommitTime()

public boolean hasLatestCommitTime()

Output only. The timestamp when the workspace was committed.

.google.protobuf.Timestamp latest_commit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the latestCommitTime field is set.

hasSource()

public boolean hasSource()

Required. The source engine details.

.google.cloud.clouddms.v1.DatabaseEngineInfo source = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the source field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the workspace resource was last updated.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversionWorkspace.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversionWorkspace.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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