Class Connection.Builder (2.17.0)

public static final class Connection.Builder extends GeneratedMessageV3.Builder<Connection.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Connection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Connection.Builder
Overrides

build()

public Connection build()
Returns
TypeDescription
Connection

buildPartial()

public Connection buildPartial()
Returns
TypeDescription
Connection

clear()

public Connection.Builder clear()
Returns
TypeDescription
Connection.Builder
Overrides

clearAws()

public Connection.Builder clearAws()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
Connection.Builder

clearAzure()

public Connection.Builder clearAzure()

Azure properties.

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

Returns
TypeDescription
Connection.Builder

clearCloudResource()

public Connection.Builder clearCloudResource()

Cloud Resource properties.

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

Returns
TypeDescription
Connection.Builder

clearCloudSpanner()

public Connection.Builder clearCloudSpanner()

Cloud Spanner properties.

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

Returns
TypeDescription
Connection.Builder

clearCloudSql()

public Connection.Builder clearCloudSql()

Cloud SQL properties.

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

Returns
TypeDescription
Connection.Builder

clearCreationTime()

public Connection.Builder clearCreationTime()

Output only. The creation timestamp of the connection.

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

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearDescription()

public Connection.Builder clearDescription()

User provided description.

string description = 3;

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Connection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Connection.Builder
Overrides

clearFriendlyName()

public Connection.Builder clearFriendlyName()

User provided display name for the connection.

string friendly_name = 2;

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearHasCredential()

public Connection.Builder clearHasCredential()

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

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

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearLastModifiedTime()

public Connection.Builder clearLastModifiedTime()

Output only. The last update timestamp of the connection.

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

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearName()

public Connection.Builder clearName()

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

string name = 1;

Returns
TypeDescription
Connection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Connection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Connection.Builder
Overrides

clearProperties()

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

clearSpark()

public Connection.Builder clearSpark()

Spark properties.

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

Returns
TypeDescription
Connection.Builder

clone()

public Connection.Builder clone()
Returns
TypeDescription
Connection.Builder
Overrides

getAws()

public AwsProperties getAws()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
AwsProperties

The aws.

getAwsBuilder()

public AwsProperties.Builder getAwsBuilder()

Amazon Web Services (AWS) properties.

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

Returns
TypeDescription
AwsProperties.Builder

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.

getAzureBuilder()

public AzureProperties.Builder getAzureBuilder()

Azure properties.

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

Returns
TypeDescription
AzureProperties.Builder

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.

getCloudResourceBuilder()

public CloudResourceProperties.Builder getCloudResourceBuilder()

Cloud Resource properties.

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

Returns
TypeDescription
CloudResourceProperties.Builder

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.

getCloudSpannerBuilder()

public CloudSpannerProperties.Builder getCloudSpannerBuilder()

Cloud Spanner properties.

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

Returns
TypeDescription
CloudSpannerProperties.Builder

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.

getCloudSqlBuilder()

public CloudSqlProperties.Builder getCloudSqlBuilder()

Cloud SQL properties.

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

Returns
TypeDescription
CloudSqlProperties.Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getPropertiesCase()

public Connection.PropertiesCase getPropertiesCase()
Returns
TypeDescription
Connection.PropertiesCase

getSpark()

public SparkProperties getSpark()

Spark properties.

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

Returns
TypeDescription
SparkProperties

The spark.

getSparkBuilder()

public SparkProperties.Builder getSparkBuilder()

Spark properties.

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

Returns
TypeDescription
SparkProperties.Builder

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.

hasSpark()

public boolean hasSpark()

Spark properties.

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

Returns
TypeDescription
boolean

Whether the spark field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAws(AwsProperties value)

public Connection.Builder mergeAws(AwsProperties value)

Amazon Web Services (AWS) properties.

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

Parameter
NameDescription
valueAwsProperties
Returns
TypeDescription
Connection.Builder

mergeAzure(AzureProperties value)

public Connection.Builder mergeAzure(AzureProperties value)

Azure properties.

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

Parameter
NameDescription
valueAzureProperties
Returns
TypeDescription
Connection.Builder

mergeCloudResource(CloudResourceProperties value)

public Connection.Builder mergeCloudResource(CloudResourceProperties value)

Cloud Resource properties.

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

Parameter
NameDescription
valueCloudResourceProperties
Returns
TypeDescription
Connection.Builder

mergeCloudSpanner(CloudSpannerProperties value)

public Connection.Builder mergeCloudSpanner(CloudSpannerProperties value)

Cloud Spanner properties.

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

Parameter
NameDescription
valueCloudSpannerProperties
Returns
TypeDescription
Connection.Builder

mergeCloudSql(CloudSqlProperties value)

public Connection.Builder mergeCloudSql(CloudSqlProperties value)

Cloud SQL properties.

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

Parameter
NameDescription
valueCloudSqlProperties
Returns
TypeDescription
Connection.Builder

mergeFrom(Connection other)

public Connection.Builder mergeFrom(Connection other)
Parameter
NameDescription
otherConnection
Returns
TypeDescription
Connection.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Connection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Connection.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Connection.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Connection.Builder
Overrides

mergeSpark(SparkProperties value)

public Connection.Builder mergeSpark(SparkProperties value)

Spark properties.

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

Parameter
NameDescription
valueSparkProperties
Returns
TypeDescription
Connection.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Connection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Connection.Builder
Overrides

setAws(AwsProperties value)

public Connection.Builder setAws(AwsProperties value)

Amazon Web Services (AWS) properties.

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

Parameter
NameDescription
valueAwsProperties
Returns
TypeDescription
Connection.Builder

setAws(AwsProperties.Builder builderForValue)

public Connection.Builder setAws(AwsProperties.Builder builderForValue)

Amazon Web Services (AWS) properties.

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

Parameter
NameDescription
builderForValueAwsProperties.Builder
Returns
TypeDescription
Connection.Builder

setAzure(AzureProperties value)

public Connection.Builder setAzure(AzureProperties value)

Azure properties.

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

Parameter
NameDescription
valueAzureProperties
Returns
TypeDescription
Connection.Builder

setAzure(AzureProperties.Builder builderForValue)

public Connection.Builder setAzure(AzureProperties.Builder builderForValue)

Azure properties.

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

Parameter
NameDescription
builderForValueAzureProperties.Builder
Returns
TypeDescription
Connection.Builder

setCloudResource(CloudResourceProperties value)

public Connection.Builder setCloudResource(CloudResourceProperties value)

Cloud Resource properties.

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

Parameter
NameDescription
valueCloudResourceProperties
Returns
TypeDescription
Connection.Builder

setCloudResource(CloudResourceProperties.Builder builderForValue)

public Connection.Builder setCloudResource(CloudResourceProperties.Builder builderForValue)

Cloud Resource properties.

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

Parameter
NameDescription
builderForValueCloudResourceProperties.Builder
Returns
TypeDescription
Connection.Builder

setCloudSpanner(CloudSpannerProperties value)

public Connection.Builder setCloudSpanner(CloudSpannerProperties value)

Cloud Spanner properties.

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

Parameter
NameDescription
valueCloudSpannerProperties
Returns
TypeDescription
Connection.Builder

setCloudSpanner(CloudSpannerProperties.Builder builderForValue)

public Connection.Builder setCloudSpanner(CloudSpannerProperties.Builder builderForValue)

Cloud Spanner properties.

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

Parameter
NameDescription
builderForValueCloudSpannerProperties.Builder
Returns
TypeDescription
Connection.Builder

setCloudSql(CloudSqlProperties value)

public Connection.Builder setCloudSql(CloudSqlProperties value)

Cloud SQL properties.

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

Parameter
NameDescription
valueCloudSqlProperties
Returns
TypeDescription
Connection.Builder

setCloudSql(CloudSqlProperties.Builder builderForValue)

public Connection.Builder setCloudSql(CloudSqlProperties.Builder builderForValue)

Cloud SQL properties.

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

Parameter
NameDescription
builderForValueCloudSqlProperties.Builder
Returns
TypeDescription
Connection.Builder

setCreationTime(long value)

public Connection.Builder setCreationTime(long value)

Output only. The creation timestamp of the connection.

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

Parameter
NameDescription
valuelong

The creationTime to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setDescription(String value)

public Connection.Builder setDescription(String value)

User provided description.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Connection.Builder setDescriptionBytes(ByteString value)

User provided description.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Connection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Connection.Builder
Overrides

setFriendlyName(String value)

public Connection.Builder setFriendlyName(String value)

User provided display name for the connection.

string friendly_name = 2;

Parameter
NameDescription
valueString

The friendlyName to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setFriendlyNameBytes(ByteString value)

public Connection.Builder setFriendlyNameBytes(ByteString value)

User provided display name for the connection.

string friendly_name = 2;

Parameter
NameDescription
valueByteString

The bytes for friendlyName to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setHasCredential(boolean value)

public Connection.Builder setHasCredential(boolean value)

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

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

Parameter
NameDescription
valueboolean

The hasCredential to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setLastModifiedTime(long value)

public Connection.Builder setLastModifiedTime(long value)

Output only. The last update timestamp of the connection.

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

Parameter
NameDescription
valuelong

The lastModifiedTime to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setName(String value)

public Connection.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Connection.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Connection.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Connection.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Connection.Builder
Overrides

setSpark(SparkProperties value)

public Connection.Builder setSpark(SparkProperties value)

Spark properties.

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

Parameter
NameDescription
valueSparkProperties
Returns
TypeDescription
Connection.Builder

setSpark(SparkProperties.Builder builderForValue)

public Connection.Builder setSpark(SparkProperties.Builder builderForValue)

Spark properties.

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

Parameter
NameDescription
builderForValueSparkProperties.Builder
Returns
TypeDescription
Connection.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Connection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Connection.Builder
Overrides