Class Folder.Builder (1.54.0) 

public static final class Folder.Builder extends GeneratedMessageV3.Builder<Folder.Builder> implements FolderOrBuilder

A folder in an organization's resource hierarchy, used to organize that organization's resources.

Protobuf type google.cloud.resourcemanager.v3.Folder

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Folder.Builder

Implements

FolderOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Folder.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Folder.Builder
Overrides

build()

public Folder build()
Returns
Type Description
Folder

buildPartial()

public Folder buildPartial()
Returns
Type Description
Folder

clear()

public Folder.Builder clear()
Returns
Type Description
Folder.Builder
Overrides

clearCreateTime()

public Folder.Builder clearCreateTime()

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

clearDeleteTime()

public Folder.Builder clearDeleteTime()

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

clearDisplayName()

public Folder.Builder clearDisplayName()

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: \p{L}\p{N}?.

string display_name = 3;

Returns
Type Description
Folder.Builder

This builder for chaining.

clearEtag()

public Folder.Builder clearEtag()

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Folder.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Folder.Builder
Overrides

clearName()

public Folder.Builder clearName()

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Folder.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Folder.Builder
Overrides

clearParent()

public Folder.Builder clearParent()

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

string parent = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearState()

public Folder.Builder clearState()

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

.google.cloud.resourcemanager.v3.Folder.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearUpdateTime()

public Folder.Builder clearUpdateTime()

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

clone()

public Folder.Builder clone()
Returns
Type Description
Folder.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Folder getDefaultInstanceForType()
Returns
Type Description
Folder

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: \p{L}\p{N}?.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: \p{L}\p{N}?.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

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 folder. Its format is folders/{folder_id}, for example: "folders/1234".

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParent()

public String getParent()

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

string parent = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

string parent = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getState()

public Folder.State getState()

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

.google.cloud.resourcemanager.v3.Folder.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.State

The state.

getStateValue()

public int getStateValue()

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

.google.cloud.resourcemanager.v3.Folder.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Folder.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

mergeDeleteTime(Timestamp value)

public Folder.Builder mergeDeleteTime(Timestamp value)

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

mergeFrom(Folder other)

public Folder.Builder mergeFrom(Folder other)
Parameter
Name Description
other Folder
Returns
Type Description
Folder.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Folder.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Folder.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Folder.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Folder.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Folder.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Folder.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

setCreateTime(Timestamp value)

public Folder.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Folder.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the folder was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Folder.Builder

setDeleteTime(Timestamp value)

public Folder.Builder setDeleteTime(Timestamp value)

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Folder.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the folder was requested to be deleted.

.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Folder.Builder

setDisplayName(String value)

public Folder.Builder setDisplayName(String value)

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: \p{L}\p{N}?.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Folder.Builder setDisplayNameBytes(ByteString value)

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: \p{L}\p{N}?.

string display_name = 3;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setEtag(String value)

public Folder.Builder setEtag(String value)

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Folder.Builder setEtagBytes(ByteString value)

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Folder.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Folder.Builder
Overrides

setName(String value)

public Folder.Builder setName(String value)

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Folder.Builder setNameBytes(ByteString value)

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setParent(String value)

public Folder.Builder setParent(String value)

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

string parent = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setParentBytes(ByteString value)

public Folder.Builder setParentBytes(ByteString value)

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

string parent = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Folder.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Folder.Builder
Overrides

setState(Folder.State value)

public Folder.Builder setState(Folder.State value)

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

.google.cloud.resourcemanager.v3.Folder.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Folder.State

The state to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setStateValue(int value)

public Folder.Builder setStateValue(int value)

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

.google.cloud.resourcemanager.v3.Folder.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Folder.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Folder.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Folder.Builder
Overrides

setUpdateTime(Timestamp value)

public Folder.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Folder.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the folder was last modified.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Folder.Builder