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.analyticshub.v1.Listing
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BIGQUERY_DATASET_FIELD_NUMBER
public static final int BIGQUERY_DATASET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CATEGORIES_FIELD_NUMBER
public static final int CATEGORIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_PROVIDER_FIELD_NUMBER
public static final int DATA_PROVIDER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ICON_FIELD_NUMBER
public static final int ICON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRIMARY_CONTACT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PUBLISHER_FIELD_NUMBER
public static final int PUBLISHER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_ACCESS_FIELD_NUMBER
public static final int REQUEST_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESTRICTED_EXPORT_CONFIG_FIELD_NUMBER
public static final int RESTRICTED_EXPORT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Listing getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Listing.Builder newBuilder()
newBuilder(Listing prototype)
public static Listing.Builder newBuilder(Listing prototype)
| Parameter |
| Name |
Description |
prototype |
Listing
|
public static Listing parseDelimitedFrom(InputStream input)
public static Listing parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Listing parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Listing parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(CodedInputStream input)
public static Listing parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(InputStream input)
public static Listing parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Listing parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Listing parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Listing> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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];
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.
|
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];
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];
getDefaultInstanceForType()
public Listing getDefaultInstanceForType()
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.
|
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];
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.
|
getParserForType()
public Parser<Listing> getParserForType()
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];
| Returns |
| 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];
| 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.
|
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];
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSourceCase()
public Listing.SourceCase getSourceCase()
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];
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Listing.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Listing.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Listing.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
