Class ConnectionProfile (2.27.0)

public final class ConnectionProfile extends GeneratedMessageV3 implements ConnectionProfileOrBuilder

A connection profile definition.

Protobuf type google.cloud.clouddms.v1.ConnectionProfile

Static Fields

ALLOYDB_FIELD_NUMBER

public static final int ALLOYDB_FIELD_NUMBER
Field Value
TypeDescription
int

CLOUDSQL_FIELD_NUMBER

public static final int CLOUDSQL_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MYSQL_FIELD_NUMBER

public static final int MYSQL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ORACLE_FIELD_NUMBER

public static final int ORACLE_FIELD_NUMBER
Field Value
TypeDescription
int

POSTGRESQL_FIELD_NUMBER

public static final int POSTGRESQL_FIELD_NUMBER
Field Value
TypeDescription
int

PROVIDER_FIELD_NUMBER

public static final int PROVIDER_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ConnectionProfile getDefaultInstance()
Returns
TypeDescription
ConnectionProfile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ConnectionProfile.Builder newBuilder()
Returns
TypeDescription
ConnectionProfile.Builder

newBuilder(ConnectionProfile prototype)

public static ConnectionProfile.Builder newBuilder(ConnectionProfile prototype)
Parameter
NameDescription
prototypeConnectionProfile
Returns
TypeDescription
ConnectionProfile.Builder

parseDelimitedFrom(InputStream input)

public static ConnectionProfile parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ConnectionProfile parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConnectionProfile parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConnectionProfile parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ConnectionProfile parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ConnectionProfile parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConnectionProfile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConnectionProfile
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ConnectionProfile> parser()
Returns
TypeDescription
Parser<ConnectionProfile>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlloydb()

public AlloyDbConnectionProfile getAlloydb()

An AlloyDB cluster connection profile.

.google.cloud.clouddms.v1.AlloyDbConnectionProfile alloydb = 105;

Returns
TypeDescription
AlloyDbConnectionProfile

The alloydb.

getAlloydbOrBuilder()

public AlloyDbConnectionProfileOrBuilder getAlloydbOrBuilder()

An AlloyDB cluster connection profile.

.google.cloud.clouddms.v1.AlloyDbConnectionProfile alloydb = 105;

Returns
TypeDescription
AlloyDbConnectionProfileOrBuilder

getCloudsql()

public CloudSqlConnectionProfile getCloudsql()

A CloudSQL database connection profile.

.google.cloud.clouddms.v1.CloudSqlConnectionProfile cloudsql = 102;

Returns
TypeDescription
CloudSqlConnectionProfile

The cloudsql.

getCloudsqlOrBuilder()

public CloudSqlConnectionProfileOrBuilder getCloudsqlOrBuilder()

A CloudSQL database connection profile.

.google.cloud.clouddms.v1.CloudSqlConnectionProfile cloudsql = 102;

Returns
TypeDescription
CloudSqlConnectionProfileOrBuilder

getConnectionProfileCase()

public ConnectionProfile.ConnectionProfileCase getConnectionProfileCase()
Returns
TypeDescription
ConnectionProfile.ConnectionProfileCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ConnectionProfile getDefaultInstanceForType()
Returns
TypeDescription
ConnectionProfile

getDisplayName()

public String getDisplayName()

The connection profile display name.

string display_name = 6;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The connection profile display name.

string display_name = 6;

Returns
TypeDescription
ByteString

The bytes for displayName.

getError()

public Status getError()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMysql()

public MySqlConnectionProfile getMysql()

A MySQL database connection profile.

.google.cloud.clouddms.v1.MySqlConnectionProfile mysql = 100;

Returns
TypeDescription
MySqlConnectionProfile

The mysql.

getMysqlOrBuilder()

public MySqlConnectionProfileOrBuilder getMysqlOrBuilder()

A MySQL database connection profile.

.google.cloud.clouddms.v1.MySqlConnectionProfile mysql = 100;

Returns
TypeDescription
MySqlConnectionProfileOrBuilder

getName()

public String getName()

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOracle()

public OracleConnectionProfile getOracle()

An Oracle database connection profile.

.google.cloud.clouddms.v1.OracleConnectionProfile oracle = 104;

Returns
TypeDescription
OracleConnectionProfile

The oracle.

getOracleOrBuilder()

public OracleConnectionProfileOrBuilder getOracleOrBuilder()

An Oracle database connection profile.

.google.cloud.clouddms.v1.OracleConnectionProfile oracle = 104;

Returns
TypeDescription
OracleConnectionProfileOrBuilder

getParserForType()

public Parser<ConnectionProfile> getParserForType()
Returns
TypeDescription
Parser<ConnectionProfile>
Overrides

getPostgresql()

public PostgreSqlConnectionProfile getPostgresql()

A PostgreSQL database connection profile.

.google.cloud.clouddms.v1.PostgreSqlConnectionProfile postgresql = 101;

Returns
TypeDescription
PostgreSqlConnectionProfile

The postgresql.

getPostgresqlOrBuilder()

public PostgreSqlConnectionProfileOrBuilder getPostgresqlOrBuilder()

A PostgreSQL database connection profile.

.google.cloud.clouddms.v1.PostgreSqlConnectionProfile postgresql = 101;

Returns
TypeDescription
PostgreSqlConnectionProfileOrBuilder

getProvider()

public DatabaseProvider getProvider()

The database provider.

.google.cloud.clouddms.v1.DatabaseProvider provider = 8;

Returns
TypeDescription
DatabaseProvider

The provider.

getProviderValue()

public int getProviderValue()

The database provider.

.google.cloud.clouddms.v1.DatabaseProvider provider = 8;

Returns
TypeDescription
int

The enum numeric value on the wire for provider.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public ConnectionProfile.State getState()

The current connection profile state (e.g. DRAFT, READY, or FAILED).

.google.cloud.clouddms.v1.ConnectionProfile.State state = 5;

Returns
TypeDescription
ConnectionProfile.State

The state.

getStateValue()

public int getStateValue()

The current connection profile state (e.g. DRAFT, READY, or FAILED).

.google.cloud.clouddms.v1.ConnectionProfile.State state = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
TimestampOrBuilder

hasAlloydb()

public boolean hasAlloydb()

An AlloyDB cluster connection profile.

.google.cloud.clouddms.v1.AlloyDbConnectionProfile alloydb = 105;

Returns
TypeDescription
boolean

Whether the alloydb field is set.

hasCloudsql()

public boolean hasCloudsql()

A CloudSQL database connection profile.

.google.cloud.clouddms.v1.CloudSqlConnectionProfile cloudsql = 102;

Returns
TypeDescription
boolean

Whether the cloudsql field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasError()

public boolean hasError()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the error field is set.

hasMysql()

public boolean hasMysql()

A MySQL database connection profile.

.google.cloud.clouddms.v1.MySqlConnectionProfile mysql = 100;

Returns
TypeDescription
boolean

Whether the mysql field is set.

hasOracle()

public boolean hasOracle()

An Oracle database connection profile.

.google.cloud.clouddms.v1.OracleConnectionProfile oracle = 104;

Returns
TypeDescription
boolean

Whether the oracle field is set.

hasPostgresql()

public boolean hasPostgresql()

A PostgreSQL database connection profile.

.google.cloud.clouddms.v1.PostgreSqlConnectionProfile postgresql = 101;

Returns
TypeDescription
boolean

Whether the postgresql field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ConnectionProfile.Builder newBuilderForType()
Returns
TypeDescription
ConnectionProfile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConnectionProfile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ConnectionProfile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ConnectionProfile.Builder toBuilder()
Returns
TypeDescription
ConnectionProfile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException