Class PrefixList.Builder (0.16.0)
public static final class PrefixList.Builder extends GeneratedMessageV3.Builder<PrefixList.Builder> implements PrefixListOrBuilder
Describes prefixes of objects to be transformed.
Protobuf type google.cloud.storagebatchoperations.v1.PrefixList
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllIncludedObjectPrefixes(Iterable<String> values)
public PrefixList.Builder addAllIncludedObjectPrefixes(Iterable<String> values)
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 |
values |
Iterable<String>
The includedObjectPrefixes to add.
|
addIncludedObjectPrefixes(String value)
public PrefixList.Builder addIncludedObjectPrefixes(String value)
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 |
value |
String
The includedObjectPrefixes to add.
|
addIncludedObjectPrefixesBytes(ByteString value)
public PrefixList.Builder addIncludedObjectPrefixesBytes(ByteString value)
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 |
value |
ByteString
The bytes of the includedObjectPrefixes to add.
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PrefixList.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PrefixList build()
buildPartial()
public PrefixList buildPartial()
clear()
public PrefixList.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PrefixList.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearIncludedObjectPrefixes()
public PrefixList.Builder clearIncludedObjectPrefixes()
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public PrefixList.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public PrefixList.Builder clone()
Overrides
getDefaultInstanceForType()
public PrefixList getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PrefixList other)
public PrefixList.Builder mergeFrom(PrefixList other)
public PrefixList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PrefixList.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PrefixList.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PrefixList.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setIncludedObjectPrefixes(int index, String value)
public PrefixList.Builder setIncludedObjectPrefixes(int index, String value)
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];
| Parameters |
| Name |
Description |
index |
int
The index to set the value at.
|
value |
String
The includedObjectPrefixes to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PrefixList.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PrefixList.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
