Class Connection (2.54.0) 

public final class Connection extends GeneratedMessageV3 implements ConnectionOrBuilder

Configuration parameters to establish connection with an external data source, except the credential attributes.

Protobuf type google.cloud.bigquery.connection.v1.Connection

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Connection

Implements

ConnectionOrBuilder

Static Fields

AWS_FIELD_NUMBER

public static final int AWS_FIELD_NUMBER
Field Value
Type Description
int

AZURE_FIELD_NUMBER

public static final int AZURE_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_RESOURCE_FIELD_NUMBER

public static final int CLOUD_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_SPANNER_FIELD_NUMBER

public static final int CLOUD_SPANNER_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_SQL_FIELD_NUMBER

public static final int CLOUD_SQL_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FRIENDLY_NAME_FIELD_NUMBER

public static final int FRIENDLY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HAS_CREDENTIAL_FIELD_NUMBER

public static final int HAS_CREDENTIAL_FIELD_NUMBER
Field Value
Type Description
int

LAST_MODIFIED_TIME_FIELD_NUMBER

public static final int LAST_MODIFIED_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SALESFORCE_DATA_CLOUD_FIELD_NUMBER

public static final int SALESFORCE_DATA_CLOUD_FIELD_NUMBER
Field Value
Type Description
int

SPARK_FIELD_NUMBER

public static final int SPARK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Connection getDefaultInstance()
Returns
Type Description
Connection

getDescriptor()

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

newBuilder()

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

newBuilder(Connection prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAws()

public AwsProperties getAws()

Amazon Web Services (AWS) properties.

.google.cloud.bigquery.connection.v1.AwsProperties aws = 8;

Returns
Type Description
AwsProperties

The aws.

getAwsOrBuilder()

public AwsPropertiesOrBuilder getAwsOrBuilder()

Amazon Web Services (AWS) properties.

.google.cloud.bigquery.connection.v1.AwsProperties aws = 8;

Returns
Type Description
AwsPropertiesOrBuilder

getAzure()

public AzureProperties getAzure()

Azure properties.

.google.cloud.bigquery.connection.v1.AzureProperties azure = 11;

Returns
Type Description
AzureProperties

The azure.

getAzureOrBuilder()

public AzurePropertiesOrBuilder getAzureOrBuilder()

Azure properties.

.google.cloud.bigquery.connection.v1.AzureProperties azure = 11;

Returns
Type Description
AzurePropertiesOrBuilder

getCloudResource()

public CloudResourceProperties getCloudResource()

Cloud Resource properties.

.google.cloud.bigquery.connection.v1.CloudResourceProperties cloud_resource = 22;

Returns
Type Description
CloudResourceProperties

The cloudResource.

getCloudResourceOrBuilder()

public CloudResourcePropertiesOrBuilder getCloudResourceOrBuilder()

Cloud Resource properties.

.google.cloud.bigquery.connection.v1.CloudResourceProperties cloud_resource = 22;

Returns
Type Description
CloudResourcePropertiesOrBuilder

getCloudSpanner()

public CloudSpannerProperties getCloudSpanner()

Cloud Spanner properties.

.google.cloud.bigquery.connection.v1.CloudSpannerProperties cloud_spanner = 21;

Returns
Type Description
CloudSpannerProperties

The cloudSpanner.

getCloudSpannerOrBuilder()

public CloudSpannerPropertiesOrBuilder getCloudSpannerOrBuilder()

Cloud Spanner properties.

.google.cloud.bigquery.connection.v1.CloudSpannerProperties cloud_spanner = 21;

Returns
Type Description
CloudSpannerPropertiesOrBuilder

getCloudSql()

public CloudSqlProperties getCloudSql()

Cloud SQL properties.

.google.cloud.bigquery.connection.v1.CloudSqlProperties cloud_sql = 4;

Returns
Type Description
CloudSqlProperties

The cloudSql.

getCloudSqlOrBuilder()

public CloudSqlPropertiesOrBuilder getCloudSqlOrBuilder()

Cloud SQL properties.

.google.cloud.bigquery.connection.v1.CloudSqlProperties cloud_sql = 4;

Returns
Type Description
CloudSqlPropertiesOrBuilder

getCreationTime()

public long getCreationTime()

Output only. The creation timestamp of the connection.

int64 creation_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The creationTime.

getDefaultInstanceForType()

public Connection getDefaultInstanceForType()
Returns
Type Description
Connection

getDescription()

public String getDescription()

User provided description.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User provided description.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getFriendlyName()

public String getFriendlyName()

User provided display name for the connection.

string friendly_name = 2;

Returns
Type Description
String

The friendlyName.

getFriendlyNameBytes()

public ByteString getFriendlyNameBytes()

User provided display name for the connection.

string friendly_name = 2;

Returns
Type Description
ByteString

The bytes for friendlyName.

getHasCredential()

public boolean getHasCredential()

Output only. True, if credential is configured for this connection.

bool has_credential = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The hasCredential.

getLastModifiedTime()

public long getLastModifiedTime()

Output only. The last update timestamp of the connection.

int64 last_modified_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The lastModifiedTime.

getName()

public String getName()

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPropertiesCase()

public Connection.PropertiesCase getPropertiesCase()
Returns
Type Description
Connection.PropertiesCase

getSalesforceDataCloud()

public SalesforceDataCloudProperties getSalesforceDataCloud()

Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection.

.google.cloud.bigquery.connection.v1.SalesforceDataCloudProperties salesforce_data_cloud = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SalesforceDataCloudProperties

The salesforceDataCloud.

getSalesforceDataCloudOrBuilder()

public SalesforceDataCloudPropertiesOrBuilder getSalesforceDataCloudOrBuilder()

Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection.

.google.cloud.bigquery.connection.v1.SalesforceDataCloudProperties salesforce_data_cloud = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SalesforceDataCloudPropertiesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpark()

public SparkProperties getSpark()

Spark properties.

.google.cloud.bigquery.connection.v1.SparkProperties spark = 23;

Returns
Type Description
SparkProperties

The spark.

getSparkOrBuilder()

public SparkPropertiesOrBuilder getSparkOrBuilder()

Spark properties.

.google.cloud.bigquery.connection.v1.SparkProperties spark = 23;

Returns
Type Description
SparkPropertiesOrBuilder

hasAws()

public boolean hasAws()

Amazon Web Services (AWS) properties.

.google.cloud.bigquery.connection.v1.AwsProperties aws = 8;

Returns
Type Description
boolean

Whether the aws field is set.

hasAzure()

public boolean hasAzure()

Azure properties.

.google.cloud.bigquery.connection.v1.AzureProperties azure = 11;

Returns
Type Description
boolean

Whether the azure field is set.

hasCloudResource()

public boolean hasCloudResource()

Cloud Resource properties.

.google.cloud.bigquery.connection.v1.CloudResourceProperties cloud_resource = 22;

Returns
Type Description
boolean

Whether the cloudResource field is set.

hasCloudSpanner()

public boolean hasCloudSpanner()

Cloud Spanner properties.

.google.cloud.bigquery.connection.v1.CloudSpannerProperties cloud_spanner = 21;

Returns
Type Description
boolean

Whether the cloudSpanner field is set.

hasCloudSql()

public boolean hasCloudSql()

Cloud SQL properties.

.google.cloud.bigquery.connection.v1.CloudSqlProperties cloud_sql = 4;

Returns
Type Description
boolean

Whether the cloudSql field is set.

hasSalesforceDataCloud()

public boolean hasSalesforceDataCloud()

Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection.

.google.cloud.bigquery.connection.v1.SalesforceDataCloudProperties salesforce_data_cloud = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the salesforceDataCloud field is set.

hasSpark()

public boolean hasSpark()

Spark properties.

.google.cloud.bigquery.connection.v1.SparkProperties spark = 23;

Returns
Type Description
boolean

Whether the spark field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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