Class Listing (2.24.0)

public final class Listing extends GeneratedMessageV3 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.dataexchange.v1beta1.Listing

Implements

ListingOrBuilder

Static Fields

BIGQUERY_DATASET_FIELD_NUMBER

public static final int BIGQUERY_DATASET_FIELD_NUMBER
Field Value
TypeDescription
int

CATEGORIES_FIELD_NUMBER

public static final int CATEGORIES_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_PROVIDER_FIELD_NUMBER

public static final int DATA_PROVIDER_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENTATION_FIELD_NUMBER

public static final int DOCUMENTATION_FIELD_NUMBER
Field Value
TypeDescription
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRIMARY_CONTACT_FIELD_NUMBER

public static final int PRIMARY_CONTACT_FIELD_NUMBER
Field Value
TypeDescription
int

PUBLISHER_FIELD_NUMBER

public static final int PUBLISHER_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ACCESS_FIELD_NUMBER

public static final int REQUEST_ACCESS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Listing getDefaultInstance()
Returns
TypeDescription
Listing

getDescriptor()

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

newBuilder()

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

newBuilder(Listing prototype)

public static Listing.Builder newBuilder(Listing prototype)
Parameter
NameDescription
prototypeListing
Returns
TypeDescription
Listing.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBigqueryDataset()

public Listing.BigQueryDatasetSource getBigqueryDataset()

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

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

Returns
TypeDescription
Listing.BigQueryDatasetSource

The bigqueryDataset.

getBigqueryDatasetOrBuilder()

public Listing.BigQueryDatasetSourceOrBuilder getBigqueryDatasetOrBuilder()

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

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

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.dataexchange.v1beta1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DataProvider

The dataProvider.

getDataProviderOrBuilder()

public DataProviderOrBuilder getDataProviderOrBuilder()

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

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

Returns
TypeDescription
DataProviderOrBuilder

getDefaultInstanceForType()

public Listing getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

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

The bytes for displayName.

getDocumentation()

public String getDocumentation()

Optional. Documentation describing the listing.

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

Returns
TypeDescription
String

The documentation.

getDocumentationBytes()

public ByteString getDocumentationBytes()

Optional. Documentation describing the listing.

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

The bytes for name.

getParserForType()

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

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
TypeDescription
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
TypeDescription
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.dataexchange.v1beta1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Publisher

The publisher.

getPublisherOrBuilder()

public PublisherOrBuilder getPublisherOrBuilder()

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

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

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

The bytes for requestAccess.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Listing.SourceCase getSourceCase()
Returns
TypeDescription
Listing.SourceCase

getState()

public Listing.State getState()

Output only. Current state of the listing.

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

Returns
TypeDescription
Listing.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the listing.

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

Returns
TypeDescription
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.dataexchange.v1beta1.Listing.BigQueryDatasetSource bigquery_dataset = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.dataexchange.v1beta1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the dataProvider 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.dataexchange.v1beta1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the publisher field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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