Class DataExchange.Builder (0.51.0)

public static final class DataExchange.Builder extends GeneratedMessageV3.Builder<DataExchange.Builder> implements DataExchangeOrBuilder

A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.

Protobuf type google.cloud.bigquery.analyticshub.v1.DataExchange

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataExchange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataExchange.Builder
Overrides

build()

public DataExchange build()
Returns
Type Description
DataExchange

buildPartial()

public DataExchange buildPartial()
Returns
Type Description
DataExchange

clear()

public DataExchange.Builder clear()
Returns
Type Description
DataExchange.Builder
Overrides

clearDescription()

public DataExchange.Builder clearDescription()

Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearDiscoveryType()

public DataExchange.Builder clearDiscoveryType()

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearDisplayName()

public DataExchange.Builder clearDisplayName()

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearDocumentation()

public DataExchange.Builder clearDocumentation()

Optional. Documentation describing the data exchange.

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataExchange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DataExchange.Builder
Overrides

clearIcon()

public DataExchange.Builder clearIcon()

Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

bytes icon = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearListingCount()

public DataExchange.Builder clearListingCount()

Output only. Number of listings contained in the data exchange.

int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearName()

public DataExchange.Builder clearName()

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DataExchange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DataExchange.Builder
Overrides

clearPrimaryContact()

public DataExchange.Builder clearPrimaryContact()

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.

string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

This builder for chaining.

clearSharingEnvironmentConfig()

public DataExchange.Builder clearSharingEnvironmentConfig()

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataExchange.Builder

clone()

public DataExchange.Builder clone()
Returns
Type Description
DataExchange.Builder
Overrides

getDefaultInstanceForType()

public DataExchange getDefaultInstanceForType()
Returns
Type Description
DataExchange

getDescription()

public String getDescription()

Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiscoveryType()

public DiscoveryType getDiscoveryType()

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DiscoveryType

The discoveryType.

getDiscoveryTypeValue()

public int getDiscoveryTypeValue()

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for discoveryType.

getDisplayName()

public String getDisplayName()

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getDocumentation()

public String getDocumentation()

Optional. Documentation describing the data exchange.

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The documentation.

getDocumentationBytes()

public ByteString getDocumentationBytes()

Optional. Documentation describing the data exchange.

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for documentation.

getIcon()

public ByteString getIcon()

Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

bytes icon = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The icon.

getListingCount()

public int getListingCount()

Output only. Number of listings contained in the data exchange.

int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The listingCount.

getName()

public String getName()

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPrimaryContact()

public String getPrimaryContact()

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.

string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The primaryContact.

getPrimaryContactBytes()

public ByteString getPrimaryContactBytes()

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.

string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for primaryContact.

getSharingEnvironmentConfig()

public SharingEnvironmentConfig getSharingEnvironmentConfig()

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SharingEnvironmentConfig

The sharingEnvironmentConfig.

getSharingEnvironmentConfigBuilder()

public SharingEnvironmentConfig.Builder getSharingEnvironmentConfigBuilder()

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SharingEnvironmentConfig.Builder

getSharingEnvironmentConfigOrBuilder()

public SharingEnvironmentConfigOrBuilder getSharingEnvironmentConfigOrBuilder()

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SharingEnvironmentConfigOrBuilder

hasDiscoveryType()

public boolean hasDiscoveryType()

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the discoveryType field is set.

hasSharingEnvironmentConfig()

public boolean hasSharingEnvironmentConfig()

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sharingEnvironmentConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataExchange other)

public DataExchange.Builder mergeFrom(DataExchange other)
Parameter
Name Description
other DataExchange
Returns
Type Description
DataExchange.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataExchange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataExchange.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataExchange.Builder
Overrides

mergeSharingEnvironmentConfig(SharingEnvironmentConfig value)

public DataExchange.Builder mergeSharingEnvironmentConfig(SharingEnvironmentConfig value)

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SharingEnvironmentConfig
Returns
Type Description
DataExchange.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataExchange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataExchange.Builder
Overrides

setDescription(String value)

public DataExchange.Builder setDescription(String value)

Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataExchange.Builder setDescriptionBytes(ByteString value)

Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDiscoveryType(DiscoveryType value)

public DataExchange.Builder setDiscoveryType(DiscoveryType value)

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DiscoveryType

The discoveryType to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDiscoveryTypeValue(int value)

public DataExchange.Builder setDiscoveryTypeValue(int value)

Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for discoveryType to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDisplayName(String value)

public DataExchange.Builder setDisplayName(String value)

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataExchange.Builder setDisplayNameBytes(ByteString value)

Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDocumentation(String value)

public DataExchange.Builder setDocumentation(String value)

Optional. Documentation describing the data exchange.

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The documentation to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setDocumentationBytes(ByteString value)

public DataExchange.Builder setDocumentationBytes(ByteString value)

Optional. Documentation describing the data exchange.

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for documentation to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataExchange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataExchange.Builder
Overrides

setIcon(ByteString value)

public DataExchange.Builder setIcon(ByteString value)

Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.

bytes icon = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The icon to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setListingCount(int value)

public DataExchange.Builder setListingCount(int value)

Output only. Number of listings contained in the data exchange.

int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The listingCount to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setName(String value)

public DataExchange.Builder setName(String value)

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataExchange.Builder setNameBytes(ByteString value)

Output only. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setPrimaryContact(String value)

public DataExchange.Builder setPrimaryContact(String value)

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.

string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The primaryContact to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

setPrimaryContactBytes(ByteString value)

public DataExchange.Builder setPrimaryContactBytes(ByteString value)

Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.

string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for primaryContact to set.

Returns
Type Description
DataExchange.Builder

This builder for chaining.

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

public DataExchange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DataExchange.Builder
Overrides

setSharingEnvironmentConfig(SharingEnvironmentConfig value)

public DataExchange.Builder setSharingEnvironmentConfig(SharingEnvironmentConfig value)

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SharingEnvironmentConfig
Returns
Type Description
DataExchange.Builder

setSharingEnvironmentConfig(SharingEnvironmentConfig.Builder builderForValue)

public DataExchange.Builder setSharingEnvironmentConfig(SharingEnvironmentConfig.Builder builderForValue)

Optional. Configurable data sharing environment option for a data exchange.

.google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SharingEnvironmentConfig.Builder
Returns
Type Description
DataExchange.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DataExchange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataExchange.Builder
Overrides