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.dataexchange.v1beta1.DataExchange
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_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 | |
public static final int PRIMARY_CONTACT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static DataExchange getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataExchange.Builder newBuilder()
newBuilder(DataExchange prototype)
public static DataExchange.Builder newBuilder(DataExchange prototype)
public static DataExchange parseDelimitedFrom(InputStream input)
public static DataExchange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataExchange parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataExchange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataExchange parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataExchange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataExchange parseFrom(CodedInputStream input)
public static DataExchange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataExchange parseFrom(InputStream input)
public static DataExchange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataExchange parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataExchange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataExchange> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public DataExchange getDefaultInstanceForType()
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.
|
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];
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()
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()
Overrides
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.
|
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataExchange.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataExchange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public DataExchange.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
