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
Static Fields
BIGQUERY_DATASET_FIELD_NUMBER
public static final int BIGQUERY_DATASET_FIELD_NUMBER
Field Value
CATEGORIES_FIELD_NUMBER
public static final int CATEGORIES_FIELD_NUMBER
Field Value
DATA_PROVIDER_FIELD_NUMBER
public static final int DATA_PROVIDER_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
Field Value
ICON_FIELD_NUMBER
public static final int ICON_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
public static final int PRIMARY_CONTACT_FIELD_NUMBER
Field Value
PUBLISHER_FIELD_NUMBER
public static final int PUBLISHER_FIELD_NUMBER
Field Value
REQUEST_ACCESS_FIELD_NUMBER
public static final int REQUEST_ACCESS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Listing getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Listing.Builder newBuilder()
Returns
newBuilder(Listing prototype)
public static Listing.Builder newBuilder(Listing prototype)
Parameter
Returns
public static Listing parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Listing parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Listing parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Listing parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Listing parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Listing parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Listing parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Listing parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Listing parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Listing> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
getCategories(int index)
public Category getCategories(int index)
Optional. Categories of the Listing. Up to two categories are allowed.
repeated .google.cloud.bigquery.dataexchange.common.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| 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.common.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The count of categories.
|
getCategoriesList()
public List<Category> getCategoriesList()
Optional. Categories of the Listing. Up to two categories are allowed.
repeated .google.cloud.bigquery.dataexchange.common.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
| 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.dataexchange.common.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
| 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.dataexchange.common.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| List<Integer> | A list containing the enum numeric values on the wire for categories.
|
getDataProvider()
public DataProvider getDataProvider()
Optional. The details of the Data Provider who owns the source data.
.google.cloud.bigquery.dataexchange.v1beta1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];
getDataProviderOrBuilder()
public DataProviderOrBuilder getDataProviderOrBuilder()
Optional. The details of the Data Provider who owns the source data.
.google.cloud.bigquery.dataexchange.v1beta1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public Listing getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. Short description of the listing 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];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Short description of the listing 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];
| Type | Description |
| 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
( ), 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];
| 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
( ), 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];
| Type | Description |
| ByteString | The bytes for displayName.
|
getDocumentation()
public String getDocumentation()
Optional. Documentation describing the listing.
string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The documentation.
|
getDocumentationBytes()
public ByteString getDocumentationBytes()
Optional. Documentation describing the listing.
string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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];
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];
| 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];
getParserForType()
public Parser<Listing> getParserForType()
Returns
Overrides
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];
| Type | Description |
| String | The primaryContact.
|
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];
| Type | Description |
| ByteString | The bytes for primaryContact.
|
getPublisher()
public Publisher getPublisher()
Optional. The details of the Publisher who owns the listing and has rights to share
the source data.
.google.cloud.bigquery.dataexchange.v1beta1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];
getPublisherOrBuilder()
public PublisherOrBuilder getPublisherOrBuilder()
Optional. The details of the Publisher who owns the listing and has rights to share
the source data.
.google.cloud.bigquery.dataexchange.v1beta1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];
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];
| 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];
| Type | Description |
| ByteString | The bytes for requestAccess.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceCase()
public Listing.SourceCase getSourceCase()
Returns
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| Type | Description |
| boolean | Whether the bigqueryDataset field is set.
|
hasDataProvider()
public boolean hasDataProvider()
Optional. The details of the Data Provider who owns the source data.
.google.cloud.bigquery.dataexchange.v1beta1.DataProvider data_provider = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the dataProvider field is set.
|
hasPublisher()
public boolean hasPublisher()
Optional. The details of the Publisher who owns the listing and has rights to share
the source data.
.google.cloud.bigquery.dataexchange.v1beta1.Publisher publisher = 11 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the publisher field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Listing.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Listing.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Listing.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
