Class Connection (2.31.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

Implements

ConnectionOrBuilder

Static Fields

AWS_FIELD_NUMBER

public static final int AWS_FIELD_NUMBER
Field Value
TypeDescription
int

AZURE_FIELD_NUMBER

public static final int AZURE_FIELD_NUMBER
Field Value
TypeDescription
int

CLOUD_RESOURCE_FIELD_NUMBER

public static final int CLOUD_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

CLOUD_SPANNER_FIELD_NUMBER

public static final int CLOUD_SPANNER_FIELD_NUMBER
Field Value
TypeDescription
int

CLOUD_SQL_FIELD_NUMBER

public static final int CLOUD_SQL_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

FRIENDLY_NAME_FIELD_NUMBER

public static final int FRIENDLY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

HAS_CREDENTIAL_FIELD_NUMBER

public static final int HAS_CREDENTIAL_FIELD_NUMBER
Field Value
TypeDescription
int

LAST_MODIFIED_TIME_FIELD_NUMBER

public static final int LAST_MODIFIED_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SALESFORCE_DATA_CLOUD_FIELD_NUMBER

public static final int SALESFORCE_DATA_CLOUD_FIELD_NUMBER
Field Value
TypeDescription
int

SPARK_FIELD_NUMBER

public static final int SPARK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Connection getDefaultInstance()
Returns
TypeDescription
Connection

getDescriptor()

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

newBuilder()

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

newBuilder(Connection prototype)

public static Connection.Builder newBuilder(Connection prototype)
Parameter
NameDescription
prototypeConnection
Returns
TypeDescription
Connection.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAws()

public AwsProperties getAws()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
AwsProperties

The aws.

getAwsOrBuilder()

public AwsPropertiesOrBuilder getAwsOrBuilder()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
AwsPropertiesOrBuilder

getAzure()

public AzureProperties getAzure()

Azure properties.

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

Returns
TypeDescription
AzureProperties

The azure.

getAzureOrBuilder()

public AzurePropertiesOrBuilder getAzureOrBuilder()

Azure properties.

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

Returns
TypeDescription
AzurePropertiesOrBuilder

getCloudResource()

public CloudResourceProperties getCloudResource()

Cloud Resource properties.

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

Returns
TypeDescription
CloudResourceProperties

The cloudResource.

getCloudResourceOrBuilder()

public CloudResourcePropertiesOrBuilder getCloudResourceOrBuilder()

Cloud Resource properties.

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

Returns
TypeDescription
CloudResourcePropertiesOrBuilder

getCloudSpanner()

public CloudSpannerProperties getCloudSpanner()

Cloud Spanner properties.

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

Returns
TypeDescription
CloudSpannerProperties

The cloudSpanner.

getCloudSpannerOrBuilder()

public CloudSpannerPropertiesOrBuilder getCloudSpannerOrBuilder()

Cloud Spanner properties.

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

Returns
TypeDescription
CloudSpannerPropertiesOrBuilder

getCloudSql()

public CloudSqlProperties getCloudSql()

Cloud SQL properties.

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

Returns
TypeDescription
CloudSqlProperties

The cloudSql.

getCloudSqlOrBuilder()

public CloudSqlPropertiesOrBuilder getCloudSqlOrBuilder()

Cloud SQL properties.

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

Returns
TypeDescription
CloudSqlPropertiesOrBuilder

getCreationTime()

public long getCreationTime()

Output only. The creation timestamp of the connection.

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

Returns
TypeDescription
long

The creationTime.

getDefaultInstanceForType()

public Connection getDefaultInstanceForType()
Returns
TypeDescription
Connection

getDescription()

public String getDescription()

User provided description.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User provided description.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getFriendlyName()

public String getFriendlyName()

User provided display name for the connection.

string friendly_name = 2;

Returns
TypeDescription
String

The friendlyName.

getFriendlyNameBytes()

public ByteString getFriendlyNameBytes()

User provided display name for the connection.

string friendly_name = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getPropertiesCase()

public Connection.PropertiesCase getPropertiesCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
SalesforceDataCloudPropertiesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpark()

public SparkProperties getSpark()

Spark properties.

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

Returns
TypeDescription
SparkProperties

The spark.

getSparkOrBuilder()

public SparkPropertiesOrBuilder getSparkOrBuilder()

Spark properties.

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

Returns
TypeDescription
SparkPropertiesOrBuilder

hasAws()

public boolean hasAws()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
boolean

Whether the aws field is set.

hasAzure()

public boolean hasAzure()

Azure properties.

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

Returns
TypeDescription
boolean

Whether the azure field is set.

hasCloudResource()

public boolean hasCloudResource()

Cloud Resource properties.

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

Returns
TypeDescription
boolean

Whether the cloudResource field is set.

hasCloudSpanner()

public boolean hasCloudSpanner()

Cloud Spanner properties.

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

Returns
TypeDescription
boolean

Whether the cloudSpanner field is set.

hasCloudSql()

public boolean hasCloudSql()

Cloud SQL properties.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the salesforceDataCloud field is set.

hasSpark()

public boolean hasSpark()

Spark properties.

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

Returns
TypeDescription
boolean

Whether the spark field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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