com.google.cloud.bigquery.analyticshub.v1

Interface DataExchangeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataExchange, DataExchange.Builder

public interface DataExchangeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
DiscoveryType	getDiscoveryType() Optional.
int	getDiscoveryTypeValue() Optional.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getDocumentation() Optional.
com.google.protobuf.ByteString	getDocumentationBytes() Optional.
com.google.protobuf.ByteString	getIcon() Optional.
int	getListingCount() Output only.
boolean	getLogLinkedDatasetQueryUserEmail() Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getPrimaryContact() Optional.
com.google.protobuf.ByteString	getPrimaryContactBytes() Optional.
SharingEnvironmentConfig	getSharingEnvironmentConfig() Optional.
SharingEnvironmentConfigOrBuilder	getSharingEnvironmentConfigOrBuilder() Optional.
boolean	hasDiscoveryType() Optional.
boolean	hasLogLinkedDatasetQueryUserEmail() Optional.
boolean	hasSharingEnvironmentConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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

Returns:

The name.

getNameBytes

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

Returns:

The bytes for name.

getDisplayName

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

Returns:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

getDescription

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

Returns:

The description.

getDescriptionBytes

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

Returns:

The bytes for description.

getPrimaryContact

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

Returns:

The primaryContact.

getPrimaryContactBytes

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

Returns:

The bytes for primaryContact.

getDocumentation

String getDocumentation()

 Optional. Documentation describing the data exchange.
 

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The documentation.

getDocumentationBytes

com.google.protobuf.ByteString getDocumentationBytes()

 Optional. Documentation describing the data exchange.
 

string documentation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for documentation.

getListingCount

int getListingCount()

 Output only. Number of listings contained in the data exchange.
 

int32 listing_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The listingCount.

getIcon

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

Returns:

The icon.

hasSharingEnvironmentConfig

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

Returns:

Whether the sharingEnvironmentConfig field is set.

getSharingEnvironmentConfig

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

Returns:

The sharingEnvironmentConfig.

getSharingEnvironmentConfigOrBuilder

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

hasDiscoveryType

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

Returns:

Whether the discoveryType field is set.

getDiscoveryTypeValue

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

Returns:

The enum numeric value on the wire for discoveryType.

getDiscoveryType

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

Returns:

The discoveryType.

hasLogLinkedDatasetQueryUserEmail

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

Returns:

Whether the logLinkedDatasetQueryUserEmail field is set.

getLogLinkedDatasetQueryUserEmail

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

Returns:

The logLinkedDatasetQueryUserEmail.