Package com.google.cloud.bigquery.analyticshub.v1

Interface ListingOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Listing, Listing.Builder
@Generated public interface ListingOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasBigqueryDataset

      boolean hasBigqueryDataset()
       Shared dataset i.e. BigQuery dataset source.
      .google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;
      Returns:
      Whether the bigqueryDataset field is set.

    • getBigqueryDataset

      Listing.BigQueryDatasetSource getBigqueryDataset()
       Shared dataset i.e. BigQuery dataset source.
      .google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;
      Returns:
      The bigqueryDataset.

    • getBigqueryDatasetOrBuilder

      Listing.BigQueryDatasetSourceOrBuilder getBigqueryDatasetOrBuilder()
       Shared dataset i.e. BigQuery dataset source.
      .google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource bigquery_dataset = 6;

    • hasPubsubTopic

      boolean hasPubsubTopic()
       Pub/Sub topic source.
      .google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;
      Returns:
      Whether the pubsubTopic field is set.

    • getPubsubTopic

      Listing.PubSubTopicSource getPubsubTopic()
       Pub/Sub topic source.
      .google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;
      Returns:
      The pubsubTopic.

    • getPubsubTopicOrBuilder

      Listing.PubSubTopicSourceOrBuilder getPubsubTopicOrBuilder()
       Pub/Sub topic source.
      .google.cloud.bigquery.analyticshub.v1.Listing.PubSubTopicSource pubsub_topic = 16;

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getDescription

      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:
      The description.

    • getDescriptionBytes

      com.google.protobuf.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:
      The bytes for description.

    • getPrimaryContact

      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:
      The primaryContact.

    • getPrimaryContactBytes

      com.google.protobuf.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:
      The bytes for primaryContact.

    • getDocumentation

      String getDocumentation()
       Optional. Documentation describing the listing.
      string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The documentation.

    • getDocumentationBytes

      com.google.protobuf.ByteString getDocumentationBytes()
       Optional. Documentation describing the listing.
      string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for documentation.

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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:
      The state.

    • getIcon

      com.google.protobuf.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:
      The icon.

    • hasDataProvider

      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:
      Whether the dataProvider field is set.

    • getDataProvider

      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:
      The dataProvider.

    • getDataProviderOrBuilder

      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];

    • getCategoriesList

      List<Listing.Category> getCategoriesList()
       Optional. Categories of the listing. Up to five categories are allowed.
      repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the categories.

    • getCategoriesCount

      int getCategoriesCount()
       Optional. Categories of the listing. Up to five categories are allowed.
      repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of categories.

    • getCategories

      Listing.Category getCategories(int index)
       Optional. Categories of the listing. Up to five categories are allowed.
      repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The categories at the given index.

    • getCategoriesValueList

      List<Integer> getCategoriesValueList()
       Optional. Categories of the listing. Up to five categories are allowed.
      repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for categories.

    • getCategoriesValue

      int getCategoriesValue(int index)
       Optional. Categories of the listing. Up to five categories are allowed.
      repeated .google.cloud.bigquery.analyticshub.v1.Listing.Category categories = 10 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of categories at the given index.

    • hasPublisher

      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:
      Whether the publisher field is set.

    • getPublisher

      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:
      The publisher.

    • getPublisherOrBuilder

      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

      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:
      The requestAccess.

    • getRequestAccessBytes

      com.google.protobuf.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:
      The bytes for requestAccess.

    • hasRestrictedExportConfig

      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:
      Whether the restrictedExportConfig field is set.

    • getRestrictedExportConfig

      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:
      The restrictedExportConfig.

    • getRestrictedExportConfigOrBuilder

      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];

    • hasStoredProcedureConfig

      boolean hasStoredProcedureConfig()
       Optional. If set, stored procedure configuration will be propagated and
 enforced on the linked dataset.
      .google.cloud.bigquery.analyticshub.v1.StoredProcedureConfig stored_procedure_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the storedProcedureConfig field is set.

    • getStoredProcedureConfig

      StoredProcedureConfig getStoredProcedureConfig()
       Optional. If set, stored procedure configuration will be propagated and
 enforced on the linked dataset.
      .google.cloud.bigquery.analyticshub.v1.StoredProcedureConfig stored_procedure_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The storedProcedureConfig.

    • getStoredProcedureConfigOrBuilder

      StoredProcedureConfigOrBuilder getStoredProcedureConfigOrBuilder()
       Optional. If set, stored procedure configuration will be propagated and
 enforced on the linked dataset.
      .google.cloud.bigquery.analyticshub.v1.StoredProcedureConfig stored_procedure_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • hasDiscoveryType

      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:
      Whether the discoveryType field is set.

    • getDiscoveryTypeValue

      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:
      The enum numeric value on the wire for discoveryType.

    • getDiscoveryType

      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:
      The discoveryType.

    • getResourceTypeValue

      int getResourceTypeValue()
       Output only. Listing shared asset type.
      .google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for resourceType.

    • getResourceType

      SharedResourceType getResourceType()
       Output only. Listing shared asset type.
      .google.cloud.bigquery.analyticshub.v1.SharedResourceType resource_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The resourceType.

    • hasCommercialInfo

      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:
      Whether the commercialInfo field is set.

    • getCommercialInfo

      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:
      The commercialInfo.

    • getCommercialInfoOrBuilder

      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];

    • hasLogLinkedDatasetQueryUserEmail

      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:
      Whether the logLinkedDatasetQueryUserEmail field is set.

    • getLogLinkedDatasetQueryUserEmail

      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:
      The logLinkedDatasetQueryUserEmail.

    • hasAllowOnlyMetadataSharing

      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:
      Whether the allowOnlyMetadataSharing field is set.

    • getAllowOnlyMetadataSharing

      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:
      The allowOnlyMetadataSharing.

    • getSourceCase

      Listing.SourceCase getSourceCase()