Class PrefixList (0.2.0)

public final class PrefixList extends GeneratedMessageV3 implements PrefixListOrBuilder

Describes prefixes of objects to be transformed.

Protobuf type google.cloud.storagebatchoperations.v1.PrefixList

Implements

PrefixListOrBuilder

Static Fields

INCLUDED_OBJECT_PREFIXES_FIELD_NUMBER

public static final int INCLUDED_OBJECT_PREFIXES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrefixList getDefaultInstance()
Returns
Type Description
PrefixList

getDescriptor()

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

newBuilder()

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

newBuilder(PrefixList prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PrefixList getDefaultInstanceForType()
Returns
Type Description
PrefixList

getIncludedObjectPrefixes(int index)

public String getIncludedObjectPrefixes(int index)

Optional. Include prefixes of the objects to be transformed.

  • Supports full object name
  • Supports prefix of the object name
  • Wildcards are not supported
  • Supports empty string for all objects in a bucket.

repeated string included_object_prefixes = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includedObjectPrefixes at the given index.

getIncludedObjectPrefixesBytes(int index)

public ByteString getIncludedObjectPrefixesBytes(int index)

Optional. Include prefixes of the objects to be transformed.

  • Supports full object name
  • Supports prefix of the object name
  • Wildcards are not supported
  • Supports empty string for all objects in a bucket.

repeated string included_object_prefixes = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includedObjectPrefixes at the given index.

getIncludedObjectPrefixesCount()

public int getIncludedObjectPrefixesCount()

Optional. Include prefixes of the objects to be transformed.

  • Supports full object name
  • Supports prefix of the object name
  • Wildcards are not supported
  • Supports empty string for all objects in a bucket.

repeated string included_object_prefixes = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of includedObjectPrefixes.

getIncludedObjectPrefixesList()

public ProtocolStringList getIncludedObjectPrefixesList()

Optional. Include prefixes of the objects to be transformed.

  • Supports full object name
  • Supports prefix of the object name
  • Wildcards are not supported
  • Supports empty string for all objects in a bucket.

repeated string included_object_prefixes = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the includedObjectPrefixes.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 PrefixList.Builder newBuilderForType()
Returns
Type Description
PrefixList.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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