- 0.61.0 (latest)
- 0.60.0
- 0.59.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface ListingOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAllowOnlyMetadataSharing()
public abstract boolean getAllowOnlyMetadataSharing()Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
optional bool allow_only_metadata_sharing = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The allowOnlyMetadataSharing. |
getBigqueryDataset()
public abstract Listing.BigQueryDatasetSource getBigqueryDataset()Shared dataset i.e. BigQuery dataset source.
.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;
| Returns | |
|---|---|
| Type | Description |
Listing.BigQueryDatasetSource |
The bigqueryDataset. |
getBigqueryDatasetOrBuilder()
public abstract Listing.BigQueryDatasetSourceOrBuilder getBigqueryDatasetOrBuilder()Shared dataset i.e. BigQuery dataset source.
.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;
| Returns | |
|---|---|
| Type | Description |
Listing.BigQueryDatasetSourceOrBuilder |
|
getCategories(int index)
public abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
Listing.Category |
The categories at the given index. |
getCategoriesCount()
public abstract 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 abstract 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 abstract 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 |
intThe 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 abstract 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. |
getCommercialInfo()
public abstract Listing.CommercialInfo getCommercialInfo()Output only. Commercial info contains the information about the commercial data products associated with the listing.
optional .google.cloud.bigquery.analyticshub.v1.Listing.CommercialInfo commercial_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Listing.CommercialInfo |
The commercialInfo. |
getCommercialInfoOrBuilder()
public abstract Listing.CommercialInfoOrBuilder getCommercialInfoOrBuilder()Output only. Commercial info contains the information about the commercial data products associated with the listing.
optional .google.cloud.bigquery.analyticshub.v1.Listing.CommercialInfo commercial_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Listing.CommercialInfoOrBuilder |
|
getDataProvider()
public abstract 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. |
getDataProviderOrBuilder()
public abstract 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 |
|
getDescription()
public abstract 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 abstract 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. |
getDiscoveryType()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getDocumentation()Optional. Documentation describing the listing.
string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The documentation. |
getDocumentationBytes()
public abstract 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 abstract 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. |
getLogLinkedDatasetQueryUserEmail()
public abstract boolean getLogLinkedDatasetQueryUserEmail()Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
optional bool log_linked_dataset_query_user_email = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The logLinkedDatasetQueryUserEmail. |
getName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
|
getPubsubTopic()
public abstract Listing.PubSubTopicSource getPubsubTopic()Pub/Sub topic source.
.google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;
| Returns | |
|---|---|
| Type | Description |
Listing.PubSubTopicSource |
The pubsubTopic. |
getPubsubTopicOrBuilder()
public abstract Listing.PubSubTopicSourceOrBuilder getPubsubTopicOrBuilder()Pub/Sub topic source.
.google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;
| Returns | |
|---|---|
| Type | Description |
Listing.PubSubTopicSourceOrBuilder |
|
getRequestAccess()
public abstract 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 abstract 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. |
getResourceType()
public abstract SharedResourceType getResourceType()Output only. Listing shared asset type.
.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SharedResourceType |
The resourceType. |
getResourceTypeValue()
public abstract int getResourceTypeValue()Output only. Listing shared asset type.
.google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for resourceType. |
getRestrictedExportConfig()
public abstract 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. |
getRestrictedExportConfigOrBuilder()
public abstract 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 abstract Listing.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
Listing.SourceCase |
|
getState()
public abstract 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 abstract 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. |
hasAllowOnlyMetadataSharing()
public abstract boolean hasAllowOnlyMetadataSharing()Optional. If true, the listing is only available to get the resource metadata. Listing is non subscribable.
optional bool allow_only_metadata_sharing = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the allowOnlyMetadataSharing field is set. |
hasBigqueryDataset()
public abstract boolean hasBigqueryDataset()Shared dataset i.e. BigQuery dataset source.
.google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the bigqueryDataset field is set. |
hasCommercialInfo()
public abstract boolean hasCommercialInfo()Output only. Commercial info contains the information about the commercial data products associated with the listing.
optional .google.cloud.bigquery.analyticshub.v1.Listing.CommercialInfo commercial_info = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the commercialInfo field is set. |
hasDataProvider()
public abstract 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 abstract 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. |
hasLogLinkedDatasetQueryUserEmail()
public abstract boolean hasLogLinkedDatasetQueryUserEmail()Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
optional bool log_linked_dataset_query_user_email = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the logLinkedDatasetQueryUserEmail field is set. |
hasPublisher()
public abstract 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. |
hasPubsubTopic()
public abstract boolean hasPubsubTopic()Pub/Sub topic source.
.google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pubsubTopic field is set. |
hasRestrictedExportConfig()
public abstract 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. |