Class ConnectionProfile (2.54.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
Type Description
int

CLOUDSQL_FIELD_NUMBER

public static final int CLOUDSQL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MYSQL_FIELD_NUMBER

public static final int MYSQL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORACLE_FIELD_NUMBER

public static final int ORACLE_FIELD_NUMBER
Field Value
Type Description
int

POSTGRESQL_FIELD_NUMBER

public static final int POSTGRESQL_FIELD_NUMBER
Field Value
Type Description
int

PROVIDER_FIELD_NUMBER

public static final int PROVIDER_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_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 ConnectionProfile getDefaultInstance()
Returns
Type Description
ConnectionProfile

getDescriptor()

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

newBuilder()

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

newBuilder(ConnectionProfile prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ConnectionProfile> parser()
Returns
Type Description
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
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

getAlloydb()

public AlloyDbConnectionProfile getAlloydb()

An AlloyDB cluster connection profile.

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

Returns
Type Description
AlloyDbConnectionProfile

The alloydb.

getAlloydbOrBuilder()

public AlloyDbConnectionProfileOrBuilder getAlloydbOrBuilder()

An AlloyDB cluster connection profile.

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

Returns
Type Description
AlloyDbConnectionProfileOrBuilder

getCloudsql()

public CloudSqlConnectionProfile getCloudsql()

A CloudSQL database connection profile.

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

Returns
Type Description
CloudSqlConnectionProfile

The cloudsql.

getCloudsqlOrBuilder()

public CloudSqlConnectionProfileOrBuilder getCloudsqlOrBuilder()

A CloudSQL database connection profile.

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

Returns
Type Description
CloudSqlConnectionProfileOrBuilder

getConnectionProfileCase()

public ConnectionProfile.ConnectionProfileCase getConnectionProfileCase()
Returns
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ConnectionProfile getDefaultInstanceForType()
Returns
Type Description
ConnectionProfile

getDisplayName()

public String getDisplayName()

The connection profile display name.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The connection profile display name.

string display_name = 6;

Returns
Type Description
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
Type Description
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
Type Description
com.google.rpc.StatusOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getMysql()

public MySqlConnectionProfile getMysql()

A MySQL database connection profile.

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

Returns
Type Description
MySqlConnectionProfile

The mysql.

getMysqlOrBuilder()

public MySqlConnectionProfileOrBuilder getMysqlOrBuilder()

A MySQL database connection profile.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getOracle()

public OracleConnectionProfile getOracle()

An Oracle database connection profile.

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

Returns
Type Description
OracleConnectionProfile

The oracle.

getOracleOrBuilder()

public OracleConnectionProfileOrBuilder getOracleOrBuilder()

An Oracle database connection profile.

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

Returns
Type Description
OracleConnectionProfileOrBuilder

getParserForType()

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

getPostgresql()

public PostgreSqlConnectionProfile getPostgresql()

A PostgreSQL database connection profile.

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

Returns
Type Description
PostgreSqlConnectionProfile

The postgresql.

getPostgresqlOrBuilder()

public PostgreSqlConnectionProfileOrBuilder getPostgresqlOrBuilder()

A PostgreSQL database connection profile.

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

Returns
Type Description
PostgreSqlConnectionProfileOrBuilder

getProvider()

public DatabaseProvider getProvider()

The database provider.

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

Returns
Type Description
DatabaseProvider

The provider.

getProviderValue()

public int getProviderValue()

The database provider.

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

Returns
Type Description
int

The enum numeric value on the wire for provider.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

hasAlloydb()

public boolean hasAlloydb()

An AlloyDB cluster connection profile.

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

Returns
Type Description
boolean

Whether the alloydb field is set.

hasCloudsql()

public boolean hasCloudsql()

A CloudSQL database connection profile.

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

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the error field is set.

hasMysql()

public boolean hasMysql()

A MySQL database connection profile.

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

Returns
Type Description
boolean

Whether the mysql field is set.

hasOracle()

public boolean hasOracle()

An Oracle database connection profile.

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

Returns
Type Description
boolean

Whether the oracle field is set.

hasPostgresql()

public boolean hasPostgresql()

A PostgreSQL database connection profile.

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

Returns
Type Description
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
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 ConnectionProfile.Builder newBuilderForType()
Returns
Type Description
ConnectionProfile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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