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

Class Listing

  • All Implemented Interfaces:
    ListingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Listing
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        hasBigqueryDataset in interface ListingOrBuilder
        Returns:
        Whether the bigqueryDataset field is set.

      • 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];
        Specified by:
        getBigqueryDataset in interface ListingOrBuilder
        Returns:
        The bigqueryDataset.

      • 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];
        Specified by:
        getName in interface ListingOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ListingOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getDisplayName in interface ListingOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public 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];
        Specified by:
        getDisplayNameBytes in interface ListingOrBuilder
        Returns:
        The bytes for displayName.

      • 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];
        Specified by:
        getDescription in interface ListingOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public 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];
        Specified by:
        getDescriptionBytes in interface ListingOrBuilder
        Returns:
        The bytes for description.

      • 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];
        Specified by:
        getPrimaryContact in interface ListingOrBuilder
        Returns:
        The primaryContact.

      • getPrimaryContactBytes

        public 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];
        Specified by:
        getPrimaryContactBytes in interface ListingOrBuilder
        Returns:
        The bytes for primaryContact.

      • getDocumentation

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

      • getDocumentationBytes

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

      • 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];
        Specified by:
        getStateValue in interface ListingOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface ListingOrBuilder
        Returns:
        The state.

      • getIcon

        public 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];
        Specified by:
        getIcon in interface ListingOrBuilder
        Returns:
        The icon.

      • 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];
        Specified by:
        hasDataProvider in interface ListingOrBuilder
        Returns:
        Whether the dataProvider field is set.

      • 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];
        Specified by:
        getDataProvider in interface ListingOrBuilder
        Returns:
        The dataProvider.

      • 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];
        Specified by:
        getDataProviderOrBuilder in interface ListingOrBuilder

      • 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];
        Specified by:
        getCategoriesList in interface ListingOrBuilder
        Returns:
        A list containing the categories.

      • 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];
        Specified by:
        getCategoriesCount in interface ListingOrBuilder
        Returns:
        The count of categories.

      • getCategories

        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];
        Specified by:
        getCategories in interface ListingOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The 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];
        Specified by:
        getCategoriesValueList in interface ListingOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for categories.

      • getCategoriesValue

        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];
        Specified by:
        getCategoriesValue in interface ListingOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of categories at the given index.

      • 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];
        Specified by:
        hasPublisher in interface ListingOrBuilder
        Returns:
        Whether the publisher field is set.

      • 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];
        Specified by:
        getPublisher in interface ListingOrBuilder
        Returns:
        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];
        Specified by:
        getPublisherOrBuilder in interface ListingOrBuilder

      • 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];
        Specified by:
        getRequestAccess in interface ListingOrBuilder
        Returns:
        The requestAccess.

      • getRequestAccessBytes

        public 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];
        Specified by:
        getRequestAccessBytes in interface ListingOrBuilder
        Returns:
        The bytes for requestAccess.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Listing parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Listing parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Listing.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Listing.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Listing.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Listing getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Listing> parser()

      • getParserForType

        public com.google.protobuf.Parser<Listing> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Listing getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder