Class Listing.Builder (0.45.0) 

public static final class Listing.Builder extends GeneratedMessageV3.Builder<Listing.Builder> implements ListingOrBuilder

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Listing.Builder

Implements

ListingOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllCategories(Iterable<? extends Listing.Category> values)

public Listing.Builder addAllCategories(Iterable<? extends Listing.Category> values)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.bigquery.analyticshub.v1.Listing.Category>

The categories to add.
Returns
Type Description
Listing.Builder

This builder for chaining.

addAllCategoriesValue(Iterable<Integer> values)

public Listing.Builder addAllCategoriesValue(Iterable<Integer> values)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for categories to add.
Returns
Type Description
Listing.Builder

This builder for chaining.

addCategories(Listing.Category value)

public Listing.Builder addCategories(Listing.Category value)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Listing.Category

The categories to add.
Returns
Type Description
Listing.Builder

This builder for chaining.

addCategoriesValue(int value)

public Listing.Builder addCategoriesValue(int value)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for categories to add.
Returns
Type Description
Listing.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Listing build()
Returns
Type Description
Listing

buildPartial()

public Listing buildPartial()
Returns
Type Description
Listing

clear()

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

clearBigqueryDataset()

public Listing.Builder clearBigqueryDataset()

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Listing.Builder

clearCategories()

public Listing.Builder clearCategories()

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

This builder for chaining.

clearDataProvider()

public Listing.Builder clearDataProvider()

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

clearDescription()

public Listing.Builder clearDescription()

Optional. Short description of the listing. The description must not contain Unicode non-characters and 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
Listing.Builder

This builder for chaining.

clearDiscoveryType()

public Listing.Builder clearDiscoveryType()

Optional. Type of discovery of the listing on the discovery page.

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

Returns
Type Description
Listing.Builder

This builder for chaining.

clearDisplayName()

public Listing.Builder clearDisplayName()

Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) 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
Type Description
Listing.Builder

This builder for chaining.

clearDocumentation()

public Listing.Builder clearDocumentation()

Optional. Documentation describing the listing.

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

Returns
Type Description
Listing.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIcon()

public Listing.Builder clearIcon()

Optional. Base64 encoded image representing the listing. 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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

This builder for chaining.

clearName()

public Listing.Builder clearName()

Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

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

Returns
Type Description
Listing.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPrimaryContact()

public Listing.Builder clearPrimaryContact()

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

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

Returns
Type Description
Listing.Builder

This builder for chaining.

clearPublisher()

public Listing.Builder clearPublisher()

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

clearRequestAccess()

public Listing.Builder clearRequestAccess()

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

string request_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

This builder for chaining.

clearRestrictedExportConfig()

public Listing.Builder clearRestrictedExportConfig()

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.Builder

clearSource()

public Listing.Builder clearSource()
Returns
Type Description
Listing.Builder

clearState()

public Listing.Builder clearState()

Output only. Current state of the listing.

.google.cloud.bigquery.analyticshub.v1.Listing.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Listing.Builder

This builder for chaining.

clone()

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

getBigqueryDataset()

public Listing.BigQueryDatasetSource getBigqueryDataset()

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Listing.BigQueryDatasetSource

The bigqueryDataset.

getBigqueryDatasetBuilder()

public Listing.BigQueryDatasetSource.Builder getBigqueryDatasetBuilder()

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Listing.BigQueryDatasetSource.Builder

getBigqueryDatasetOrBuilder()

public Listing.BigQueryDatasetSourceOrBuilder getBigqueryDatasetOrBuilder()

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Listing.BigQueryDatasetSourceOrBuilder

getCategories(int index)

public Listing.Category getCategories(int index)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
Listing.Category

The categories at the given index.

getCategoriesCount()

public int getCategoriesCount()

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of categories.

getCategoriesList()

public List<Listing.Category> getCategoriesList()

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Category>

A list containing the categories.

getCategoriesValue(int index)

public int getCategoriesValue(int index)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of categories at the given index.

getCategoriesValueList()

public List<Integer> getCategoriesValueList()

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for categories.

getDataProvider()

public DataProvider getDataProvider()

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProvider

The dataProvider.

getDataProviderBuilder()

public DataProvider.Builder getDataProviderBuilder()

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProvider.Builder

getDataProviderOrBuilder()

public DataProviderOrBuilder getDataProviderOrBuilder()

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProviderOrBuilder

getDefaultInstanceForType()

public Listing getDefaultInstanceForType()
Returns
Type Description
Listing

getDescription()

public String getDescription()

Optional. Short description of the listing. The description must not contain Unicode non-characters and 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. Short description of the listing. The description must not contain Unicode non-characters and 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 of the listing on the discovery page.

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

Returns
Type Description
DiscoveryType

The discoveryType.

getDiscoveryTypeValue()

public int getDiscoveryTypeValue()

Optional. Type of discovery of the listing on the discovery page.

optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 14 [(.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 listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) 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
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) 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
Type Description
ByteString

The bytes for displayName.

getDocumentation()

public String getDocumentation()

Optional. Documentation describing the listing.

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

Returns
Type Description
String

The documentation.

getDocumentationBytes()

public ByteString getDocumentationBytes()

Optional. Documentation describing the listing.

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 listing. 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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The icon.

getName()

public String getName()

Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

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 listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

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 listing. 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 listing. Max Length: 1000 bytes.

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

Returns
Type Description
ByteString

The bytes for primaryContact.

getPublisher()

public Publisher getPublisher()

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Publisher

The publisher.

getPublisherBuilder()

public Publisher.Builder getPublisherBuilder()

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Publisher.Builder

getPublisherOrBuilder()

public PublisherOrBuilder getPublisherOrBuilder()

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublisherOrBuilder

getRequestAccess()

public String getRequestAccess()

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

string request_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestAccess.

getRequestAccessBytes()

public ByteString getRequestAccessBytes()

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

string request_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestAccess.

getRestrictedExportConfig()

public Listing.RestrictedExportConfig getRestrictedExportConfig()

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.RestrictedExportConfig

The restrictedExportConfig.

getRestrictedExportConfigBuilder()

public Listing.RestrictedExportConfig.Builder getRestrictedExportConfigBuilder()

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.RestrictedExportConfig.Builder

getRestrictedExportConfigOrBuilder()

public Listing.RestrictedExportConfigOrBuilder getRestrictedExportConfigOrBuilder()

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Listing.RestrictedExportConfigOrBuilder

getSourceCase()

public Listing.SourceCase getSourceCase()
Returns
Type Description
Listing.SourceCase

getState()

public Listing.State getState()

Output only. Current state of the listing.

.google.cloud.bigquery.analyticshub.v1.Listing.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Listing.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the listing.

.google.cloud.bigquery.analyticshub.v1.Listing.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasBigqueryDataset()

public boolean hasBigqueryDataset()

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the bigqueryDataset field is set.

hasDataProvider()

public boolean hasDataProvider()

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataProvider field is set.

hasDiscoveryType()

public boolean hasDiscoveryType()

Optional. Type of discovery of the listing on the discovery page.

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

Returns
Type Description
boolean

Whether the discoveryType field is set.

hasPublisher()

public boolean hasPublisher()

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the publisher field is set.

hasRestrictedExportConfig()

public boolean hasRestrictedExportConfig()

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the restrictedExportConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigqueryDataset(Listing.BigQueryDatasetSource value)

public Listing.Builder mergeBigqueryDataset(Listing.BigQueryDatasetSource value)

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Listing.BigQueryDatasetSource
Returns
Type Description
Listing.Builder

mergeDataProvider(DataProvider value)

public Listing.Builder mergeDataProvider(DataProvider value)

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProvider
Returns
Type Description
Listing.Builder

mergeFrom(Listing other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePublisher(Publisher value)

public Listing.Builder mergePublisher(Publisher value)

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Publisher
Returns
Type Description
Listing.Builder

mergeRestrictedExportConfig(Listing.RestrictedExportConfig value)

public Listing.Builder mergeRestrictedExportConfig(Listing.RestrictedExportConfig value)

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Listing.RestrictedExportConfig
Returns
Type Description
Listing.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBigqueryDataset(Listing.BigQueryDatasetSource value)

public Listing.Builder setBigqueryDataset(Listing.BigQueryDatasetSource value)

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Listing.BigQueryDatasetSource
Returns
Type Description
Listing.Builder

setBigqueryDataset(Listing.BigQueryDatasetSource.Builder builderForValue)

public Listing.Builder setBigqueryDataset(Listing.BigQueryDatasetSource.Builder builderForValue)

Required. Shared dataset i.e. BigQuery dataset source.

.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Listing.BigQueryDatasetSource.Builder
Returns
Type Description
Listing.Builder

setCategories(int index, Listing.Category value)

public Listing.Builder setCategories(int index, Listing.Category value)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value Listing.Category

The categories to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setCategoriesValue(int index, int value)

public Listing.Builder setCategoriesValue(int index, int value)

Optional. Categories of the listing. Up to two categories are allowed.

repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for categories to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDataProvider(DataProvider value)

public Listing.Builder setDataProvider(DataProvider value)

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProvider
Returns
Type Description
Listing.Builder

setDataProvider(DataProvider.Builder builderForValue)

public Listing.Builder setDataProvider(DataProvider.Builder builderForValue)

Optional. Details of the data provider who owns the source data.

.google.cloud.bigquery.analyticshub.v1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataProvider.Builder
Returns
Type Description
Listing.Builder

setDescription(String value)

public Listing.Builder setDescription(String value)

Optional. Short description of the listing. The description must not contain Unicode non-characters and 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
Listing.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Listing.Builder setDescriptionBytes(ByteString value)

Optional. Short description of the listing. The description must not contain Unicode non-characters and 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
Listing.Builder

This builder for chaining.

setDiscoveryType(DiscoveryType value)

public Listing.Builder setDiscoveryType(DiscoveryType value)

Optional. Type of discovery of the listing on the discovery page.

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

Parameter
Name Description
value DiscoveryType

The discoveryType to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDiscoveryTypeValue(int value)

public Listing.Builder setDiscoveryTypeValue(int value)

Optional. Type of discovery of the listing on the discovery page.

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

Parameter
Name Description
value int

The enum numeric value on the wire for discoveryType to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDisplayName(String value)

public Listing.Builder setDisplayName(String value)

Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) 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
Name Description
value String

The displayName to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Listing.Builder setDisplayNameBytes(ByteString value)

Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) 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
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDocumentation(String value)

public Listing.Builder setDocumentation(String value)

Optional. Documentation describing the listing.

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

Parameter
Name Description
value String

The documentation to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setDocumentationBytes(ByteString value)

public Listing.Builder setDocumentationBytes(ByteString value)

Optional. Documentation describing the listing.

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

Parameter
Name Description
value ByteString

The bytes for documentation to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIcon(ByteString value)

public Listing.Builder setIcon(ByteString value)

Optional. Base64 encoded image representing the listing. 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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The icon to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setName(String value)

public Listing.Builder setName(String value)

Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Listing.Builder setNameBytes(ByteString value)

Output only. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setPrimaryContact(String value)

public Listing.Builder setPrimaryContact(String value)

Optional. Email or URL of the primary point of contact of the listing. 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
Listing.Builder

This builder for chaining.

setPrimaryContactBytes(ByteString value)

public Listing.Builder setPrimaryContactBytes(ByteString value)

Optional. Email or URL of the primary point of contact of the listing. 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
Listing.Builder

This builder for chaining.

setPublisher(Publisher value)

public Listing.Builder setPublisher(Publisher value)

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Publisher
Returns
Type Description
Listing.Builder

setPublisher(Publisher.Builder builderForValue)

public Listing.Builder setPublisher(Publisher.Builder builderForValue)

Optional. Details of the publisher who owns the listing and who can share the source data.

.google.cloud.bigquery.analyticshub.v1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Publisher.Builder
Returns
Type Description
Listing.Builder

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

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

setRequestAccess(String value)

public Listing.Builder setRequestAccess(String value)

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

string request_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The requestAccess to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setRequestAccessBytes(ByteString value)

public Listing.Builder setRequestAccessBytes(ByteString value)

Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.

string request_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for requestAccess to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setRestrictedExportConfig(Listing.RestrictedExportConfig value)

public Listing.Builder setRestrictedExportConfig(Listing.RestrictedExportConfig value)

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Listing.RestrictedExportConfig
Returns
Type Description
Listing.Builder

setRestrictedExportConfig(Listing.RestrictedExportConfig.Builder builderForValue)

public Listing.Builder setRestrictedExportConfig(Listing.RestrictedExportConfig.Builder builderForValue)

Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset.

.google.cloud.bigquery.analyticshub.v1.Listing.RestrictedExportConfig restricted_export_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Listing.RestrictedExportConfig.Builder
Returns
Type Description
Listing.Builder

setState(Listing.State value)

public Listing.Builder setState(Listing.State value)

Output only. Current state of the listing.

.google.cloud.bigquery.analyticshub.v1.Listing.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Listing.State

The state to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setStateValue(int value)

public Listing.Builder setStateValue(int value)

Output only. Current state of the listing.

.google.cloud.bigquery.analyticshub.v1.Listing.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Listing.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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