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

Class DataExchange.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DataExchange.Builder>
com.google.cloud.bigquery.analyticshub.v1.DataExchange.Builder
All Implemented Interfaces:
DataExchangeOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DataExchange
public static final class DataExchange.Builder extends com.google.protobuf.GeneratedMessage.Builder<DataExchange.Builder> 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

  • 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.Builder<DataExchange.Builder>

    • clear

      public DataExchange.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DataExchange.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DataExchange.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DataExchange.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataExchange.Builder>

    • mergeFrom

      public DataExchange.Builder mergeFrom(DataExchange other)

    • isInitialized

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

    • mergeFrom

      public DataExchange.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataExchange.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public DataExchange.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public DataExchange.Builder clearName()
       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];
      Returns:
      This builder for chaining.

    • setNameBytes

      public DataExchange.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDisplayName

      public DataExchange.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public DataExchange.Builder clearDisplayName()
       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];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public DataExchange.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDescription

      public DataExchange.Builder setDescription(String value)
       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];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public DataExchange.Builder clearDescription()
       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];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public DataExchange.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPrimaryContact

      public DataExchange.Builder setPrimaryContact(String value)
       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];
      Parameters:
      value - The primaryContact to set.
      Returns:
      This builder for chaining.

    • clearPrimaryContact

      public DataExchange.Builder clearPrimaryContact()
       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];
      Returns:
      This builder for chaining.

    • setPrimaryContactBytes

      public DataExchange.Builder setPrimaryContactBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for primaryContact to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDocumentation

      public DataExchange.Builder setDocumentation(String value)
       Optional. Documentation describing the data exchange.
      string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The documentation to set.
      Returns:
      This builder for chaining.

    • clearDocumentation

      public DataExchange.Builder clearDocumentation()
       Optional. Documentation describing the data exchange.
      string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setDocumentationBytes

      public DataExchange.Builder setDocumentationBytes(com.google.protobuf.ByteString value)
       Optional. Documentation describing the data exchange.
      string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for documentation to set.
      Returns:
      This builder for chaining.

    • 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.

    • setListingCount

      public DataExchange.Builder setListingCount(int value)
       Output only. Number of listings contained in the data exchange.
      int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The listingCount to set.
      Returns:
      This builder for chaining.

    • clearListingCount

      public DataExchange.Builder clearListingCount()
       Output only. Number of listings contained in the data exchange.
      int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • 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.

    • setIcon

      public DataExchange.Builder setIcon(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The icon to set.
      Returns:
      This builder for chaining.

    • clearIcon

      public DataExchange.Builder clearIcon()
       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];
      Returns:
      This builder for chaining.

    • 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.

    • setSharingEnvironmentConfig

      public DataExchange.Builder setSharingEnvironmentConfig(SharingEnvironmentConfig value)
       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];

    • setSharingEnvironmentConfig

      public DataExchange.Builder setSharingEnvironmentConfig(SharingEnvironmentConfig.Builder builderForValue)
       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];

    • mergeSharingEnvironmentConfig

      public DataExchange.Builder mergeSharingEnvironmentConfig(SharingEnvironmentConfig value)
       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];

    • clearSharingEnvironmentConfig

      public DataExchange.Builder clearSharingEnvironmentConfig()
       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];

    • getSharingEnvironmentConfigBuilder

      public SharingEnvironmentConfig.Builder getSharingEnvironmentConfigBuilder()
       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];

    • 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.

    • setDiscoveryTypeValue

      public DataExchange.Builder setDiscoveryTypeValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for discoveryType to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDiscoveryType

      public DataExchange.Builder setDiscoveryType(DiscoveryType value)
       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];
      Parameters:
      value - The discoveryType to set.
      Returns:
      This builder for chaining.

    • clearDiscoveryType

      public DataExchange.Builder clearDiscoveryType()
       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];
      Returns:
      This builder for chaining.

    • 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.

    • setLogLinkedDatasetQueryUserEmail

      public DataExchange.Builder setLogLinkedDatasetQueryUserEmail(boolean value)
       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];
      Parameters:
      value - The logLinkedDatasetQueryUserEmail to set.
      Returns:
      This builder for chaining.

    • clearLogLinkedDatasetQueryUserEmail

      public DataExchange.Builder clearLogLinkedDatasetQueryUserEmail()
       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];
      Returns:
      This builder for chaining.