Class Partition (1.31.0)

public final class Partition extends GeneratedMessageV3 implements PartitionOrBuilder

Represents partition metadata contained within entity instances.

Protobuf type google.cloud.dataplex.v1.Partition

Implements

PartitionOrBuilder

Static Fields

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Partition getDefaultInstance()
Returns
TypeDescription
Partition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Partition.Builder newBuilder()
Returns
TypeDescription
Partition.Builder

newBuilder(Partition prototype)

public static Partition.Builder newBuilder(Partition prototype)
Parameter
NameDescription
prototypePartition
Returns
TypeDescription
Partition.Builder

parseDelimitedFrom(InputStream input)

public static Partition parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Partition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Partition parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Partition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Partition parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Partition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Partition parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Partition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Partition parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Partition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Partition parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Partition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Partition
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Partition> parser()
Returns
TypeDescription
Parser<Partition>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Partition getDefaultInstanceForType()
Returns
TypeDescription
Partition

getEtag() (deprecated)

public String getEtag()

Deprecated. google.cloud.dataplex.v1.Partition.etag is deprecated. See google/cloud/dataplex/v1/metadata.proto;l=513

Optional. The etag for this partition.

string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The etag.

getEtagBytes() (deprecated)

public ByteString getEtagBytes()

Deprecated. google.cloud.dataplex.v1.Partition.etag is deprecated. See google/cloud/dataplex/v1/metadata.proto;l=513

Optional. The etag for this partition.

string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for etag.

getLocation()

public String getLocation()

Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects/<project_id>/datasets/<dataset_id>/tables/<table_id>

string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects/<project_id>/datasets/<dataset_id>/tables/<table_id>

string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for location.

getName()

public String getName()

Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode "US:CA/CA#Sunnyvale so that the request URL ends with "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the response retains the encoded format.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode "US:CA/CA#Sunnyvale so that the request URL ends with "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the response retains the encoded format.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Partition> getParserForType()
Returns
TypeDescription
Parser<Partition>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getValues(int index)

public String getValues(int index)

Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.

repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The values at the given index.

getValuesBytes(int index)

public ByteString getValuesBytes(int index)

Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.

repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the values at the given index.

getValuesCount()

public int getValuesCount()

Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.

repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

The count of values.

getValuesList()

public ProtocolStringList getValuesList()

Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.

repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ProtocolStringList

A list containing the values.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Partition.Builder newBuilderForType()
Returns
TypeDescription
Partition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Partition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Partition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Partition.Builder toBuilder()
Returns
TypeDescription
Partition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException