Class DataExchange (0.45.0)

public final class DataExchange extends GeneratedMessageV3 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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISCOVERY_TYPE_FIELD_NUMBER

public static final int DISCOVERY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENTATION_FIELD_NUMBER

public static final int DOCUMENTATION_FIELD_NUMBER
Field Value
Type Description
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
Type Description
int

LISTING_COUNT_FIELD_NUMBER

public static final int LISTING_COUNT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIMARY_CONTACT_FIELD_NUMBER

public static final int PRIMARY_CONTACT_FIELD_NUMBER
Field Value
Type Description
int

SHARING_ENVIRONMENT_CONFIG_FIELD_NUMBER

public static final int SHARING_ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataExchange getDefaultInstance()
Returns
Type Description
DataExchange

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DataExchange.Builder newBuilder()
Returns
Type Description
DataExchange.Builder

newBuilder(DataExchange prototype)

public static DataExchange.Builder newBuilder(DataExchange prototype)
Parameter
Name Description
prototype DataExchange
Returns
Type Description
DataExchange.Builder

parseDelimitedFrom(InputStream input)

public static DataExchange parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataExchange parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataExchange parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataExchange parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataExchange parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataExchange parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataExchange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataExchange
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataExchange> parser()
Returns
Type Description
Parser<DataExchange>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DataExchange getDefaultInstanceForType()
Returns
Type Description
DataExchange

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public 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
Type Description
ByteString

The bytes for description.

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

Returns
Type Description
DiscoveryType

The discoveryType.

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

Returns
Type Description
int

The enum numeric value on the wire for discoveryType.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public 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
Type Description
ByteString

The bytes for displayName.

getDocumentation()

public String getDocumentation()

Optional. Documentation describing the data exchange.

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

Returns
Type Description
String

The documentation.

getDocumentationBytes()

public ByteString getDocumentationBytes()

Optional. Documentation describing the data exchange.

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

Returns
Type Description
ByteString

The bytes for documentation.

getIcon()

public 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
Type Description
ByteString

The icon.

getListingCount()

public int getListingCount()

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

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

Returns
Type Description
int

The listingCount.

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

Returns
Type Description
String

The name.

getNameBytes()

public 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DataExchange> getParserForType()
Returns
Type Description
Parser<DataExchange>
Overrides

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

Returns
Type Description
String

The primaryContact.

getPrimaryContactBytes()

public 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
Type Description
ByteString

The bytes for primaryContact.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
SharingEnvironmentConfig

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

Returns
Type Description
SharingEnvironmentConfigOrBuilder

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

Returns
Type Description
boolean

Whether the discoveryType field is set.

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

Returns
Type Description
boolean

Whether the sharingEnvironmentConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataExchange.Builder newBuilderForType()
Returns
Type Description
DataExchange.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataExchange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataExchange.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataExchange.Builder toBuilder()
Returns
Type Description
DataExchange.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException