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

Class DataExchange

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.bigquery.analyticshub.v1.DataExchange
All Implemented Interfaces:
DataExchangeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataExchange extends com.google.protobuf.GeneratedMessage implements DataExchangeOrBuilder
 A data exchange is a container that lets you share data. Along with the
 descriptive information about the data exchange, it contains listings that
 reference shared datasets.
Protobuf type google.cloud.bigquery.analyticshub.v1.DataExchange
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • PRIMARY_CONTACT_FIELD_NUMBER

      public static final int PRIMARY_CONTACT_FIELD_NUMBER
      See Also:

    • DOCUMENTATION_FIELD_NUMBER

      public static final int DOCUMENTATION_FIELD_NUMBER
      See Also:

    • LISTING_COUNT_FIELD_NUMBER

      public static final int LISTING_COUNT_FIELD_NUMBER
      See Also:

    • ICON_FIELD_NUMBER

      public static final int ICON_FIELD_NUMBER
      See Also:

    • SHARING_ENVIRONMENT_CONFIG_FIELD_NUMBER

      public static final int SHARING_ENVIRONMENT_CONFIG_FIELD_NUMBER
      See Also:

    • DISCOVERY_TYPE_FIELD_NUMBER

      public static final int DISCOVERY_TYPE_FIELD_NUMBER
      See Also:

    • LOG_LINKED_DATASET_QUERY_USER_EMAIL_FIELD_NUMBER

      public static final int LOG_LINKED_DATASET_QUERY_USER_EMAIL_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Output only. The resource name of the data exchange.
 e.g. `projects/myproject/locations/us/dataExchanges/123`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface DataExchangeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name of the data exchange.
 e.g. `projects/myproject/locations/us/dataExchanges/123`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface DataExchangeOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. Human-readable display name of the data exchange. The display
 name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), ampersands (&) and must not 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 DataExchangeOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. Human-readable display name of the data exchange. The display
 name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), ampersands (&) and must not 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 DataExchangeOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. Description of the data exchange. 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];
      Specified by:
      getDescription in interface DataExchangeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the data exchange. 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];
      Specified by:
      getDescriptionBytes in interface DataExchangeOrBuilder
      Returns:
      The bytes for description.

    • getPrimaryContact

      public String getPrimaryContact()
       Optional. Email or URL of the primary point of contact of the data
 exchange. Max Length: 1000 bytes.
      string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrimaryContact in interface DataExchangeOrBuilder
      Returns:
      The primaryContact.

    • getPrimaryContactBytes

      public com.google.protobuf.ByteString getPrimaryContactBytes()
       Optional. Email or URL of the primary point of contact of the data
 exchange. Max Length: 1000 bytes.
      string primary_contact = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrimaryContactBytes in interface DataExchangeOrBuilder
      Returns:
      The bytes for primaryContact.

    • getDocumentation

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

    • getDocumentationBytes

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

    • getListingCount

      public int getListingCount()
       Output only. Number of listings contained in the data exchange.
      int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getListingCount in interface DataExchangeOrBuilder
      Returns:
      The listingCount.

    • getIcon

      public com.google.protobuf.ByteString getIcon()
       Optional. Base64 encoded image representing the data exchange. 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 content of the fields are base64-encoded (which increases the
 size of the data by 33-36%) when using JSON on the wire.
      bytes icon = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIcon in interface DataExchangeOrBuilder
      Returns:
      The icon.

    • hasSharingEnvironmentConfig

      public boolean hasSharingEnvironmentConfig()
       Optional. Configurable data sharing environment option for a data exchange.
      .google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSharingEnvironmentConfig in interface DataExchangeOrBuilder
      Returns:
      Whether the sharingEnvironmentConfig field is set.

    • getSharingEnvironmentConfig

      public SharingEnvironmentConfig getSharingEnvironmentConfig()
       Optional. Configurable data sharing environment option for a data exchange.
      .google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSharingEnvironmentConfig in interface DataExchangeOrBuilder
      Returns:
      The sharingEnvironmentConfig.

    • getSharingEnvironmentConfigOrBuilder

      public SharingEnvironmentConfigOrBuilder getSharingEnvironmentConfigOrBuilder()
       Optional. Configurable data sharing environment option for a data exchange.
      .google.cloud.bigquery.analyticshub.v1.SharingEnvironmentConfig sharing_environment_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSharingEnvironmentConfigOrBuilder in interface DataExchangeOrBuilder

    • hasDiscoveryType

      public boolean hasDiscoveryType()
       Optional. Type of discovery on the discovery page for all the listings
 under this exchange. Updating this field also updates (overwrites) the
 discovery_type field for all the listings under this exchange.
      optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDiscoveryType in interface DataExchangeOrBuilder
      Returns:
      Whether the discoveryType field is set.

    • getDiscoveryTypeValue

      public int getDiscoveryTypeValue()
       Optional. Type of discovery on the discovery page for all the listings
 under this exchange. Updating this field also updates (overwrites) the
 discovery_type field for all the listings under this exchange.
      optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDiscoveryTypeValue in interface DataExchangeOrBuilder
      Returns:
      The enum numeric value on the wire for discoveryType.

    • getDiscoveryType

      public DiscoveryType getDiscoveryType()
       Optional. Type of discovery on the discovery page for all the listings
 under this exchange. Updating this field also updates (overwrites) the
 discovery_type field for all the listings under this exchange.
      optional .google.cloud.bigquery.analyticshub.v1.DiscoveryType discovery_type = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDiscoveryType in interface DataExchangeOrBuilder
      Returns:
      The discoveryType.

    • hasLogLinkedDatasetQueryUserEmail

      public boolean hasLogLinkedDatasetQueryUserEmail()
       Optional. By default, false.
 If true, the DataExchange has an email sharing mandate enabled.
      optional bool log_linked_dataset_query_user_email = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasLogLinkedDatasetQueryUserEmail in interface DataExchangeOrBuilder
      Returns:
      Whether the logLinkedDatasetQueryUserEmail field is set.

    • getLogLinkedDatasetQueryUserEmail

      public boolean getLogLinkedDatasetQueryUserEmail()
       Optional. By default, false.
 If true, the DataExchange has an email sharing mandate enabled.
      optional bool log_linked_dataset_query_user_email = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLogLinkedDatasetQueryUserEmail in interface DataExchangeOrBuilder
      Returns:
      The logLinkedDatasetQueryUserEmail.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 DataExchange parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DataExchange parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataExchange parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataExchange parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataExchange parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataExchange parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataExchange.Builder newBuilder()

    • newBuilder

      public static DataExchange.Builder newBuilder(DataExchange prototype)

    • toBuilder

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

    • newBuilderForType

      protected DataExchange.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataExchange getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DataExchange> 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.GeneratedMessage

    • getDefaultInstanceForType

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