public static final class PrefixList.Builder extends GeneratedMessage.Builder<PrefixList.Builder> implements PrefixListOrBuilderDescribes prefixes of objects to be transformed.
Protobuf type google.cloud.storagebatchoperations.v1.PrefixList
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PrefixList.BuilderImplements
PrefixListOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
This builder for chaining. |
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 |
StringThe includedObjectPrefixes to add. |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes of the includedObjectPrefixes to add. |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
This builder for chaining. |
build()
public PrefixList build()| Returns | |
|---|---|
| Type | Description |
PrefixList |
|
buildPartial()
public PrefixList buildPartial()| Returns | |
|---|---|
| Type | Description |
PrefixList |
|
clear()
public PrefixList.Builder clear()| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public PrefixList getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PrefixList |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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 |
intThe 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PrefixList other)
public PrefixList.Builder mergeFrom(PrefixList other)| Parameter | |
|---|---|
| Name | Description |
other |
PrefixList |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PrefixList.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PrefixList.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
|
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 |
intThe index to set the value at. |
value |
StringThe includedObjectPrefixes to set. |
| Returns | |
|---|---|
| Type | Description |
PrefixList.Builder |
This builder for chaining. |