Class DataExchange.Builder (0.3.0)

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

A data exchange is a container that enables data sharing. It contains a set of listings of the data sources along with descriptive information of the data exchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DataExchange

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataExchange build()
Returns
TypeDescription
DataExchange

buildPartial()

public DataExchange buildPartial()
Returns
TypeDescription
DataExchange

clear()

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

clearDescription()

public DataExchange.Builder clearDescription()

Optional. Short description of the data exchange that can consist of sentences or paragraphs. 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
TypeDescription
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 ( ), and can't 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
TypeDescription
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
TypeDescription
DataExchange.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataExchange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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 contents of the field 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
TypeDescription
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
TypeDescription
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
TypeDescription
DataExchange.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPrimaryContact()

public DataExchange.Builder clearPrimaryContact()

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

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

Returns
TypeDescription
DataExchange.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public DataExchange getDefaultInstanceForType()
Returns
TypeDescription
DataExchange

getDescription()

public String getDescription()

Optional. Short description of the data exchange that can consist of sentences or paragraphs. 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
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Short description of the data exchange that can consist of sentences or paragraphs. 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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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 ( ), and can't 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
TypeDescription
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 ( ), and can't 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
TypeDescription
ByteString

The bytes for displayName.

getDocumentation()

public String getDocumentation()

Optional. Documentation describing the data exchange.

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

Returns
TypeDescription
String

The documentation.

getDocumentationBytes()

public ByteString getDocumentationBytes()

Optional. Documentation describing the data exchange.

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

Returns
TypeDescription
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 contents of the field 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getPrimaryContact()

public String getPrimaryContact()

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

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

Returns
TypeDescription
String

The primaryContact.

getPrimaryContactBytes()

public ByteString getPrimaryContactBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for primaryContact.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DataExchange other)

public DataExchange.Builder mergeFrom(DataExchange other)
Parameter
NameDescription
otherDataExchange
Returns
TypeDescription
DataExchange.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDescription(String value)

public DataExchange.Builder setDescription(String value)

Optional. Short description of the data exchange that can consist of sentences or paragraphs. 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
NameDescription
valueString

The description to set.

Returns
TypeDescription
DataExchange.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataExchange.Builder setDescriptionBytes(ByteString value)

Optional. Short description of the data exchange that can consist of sentences or paragraphs. 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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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 ( ), and can't 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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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 ( ), and can't 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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
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
NameDescription
valueString

The documentation to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for documentation to set.

Returns
TypeDescription
DataExchange.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DataExchange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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 contents of the field 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
NameDescription
valueByteString

The icon to set.

Returns
TypeDescription
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
NameDescription
valueint

The listingCount to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
DataExchange.Builder

This builder for chaining.

setPrimaryContact(String value)

public DataExchange.Builder setPrimaryContact(String value)

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

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

Parameter
NameDescription
valueString

The primaryContact to set.

Returns
TypeDescription
DataExchange.Builder

This builder for chaining.

setPrimaryContactBytes(ByteString value)

public DataExchange.Builder setPrimaryContactBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for primaryContact to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DataExchange.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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