Class Folder.Builder (0.84.0)

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

Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.

Protobuf type google.cloud.dataform.v1beta1.Folder

Implements

FolderOrBuilder

Static Methods

getDescriptor()

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

Methods

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

clearContainingFolder()

public Folder.Builder clearContainingFolder()

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.

string containing_folder = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearCreateTime()

public Folder.Builder clearCreateTime()

Output only. The timestamp of when the Folder was created.

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

Returns
Type Description
Folder.Builder

clearCreatorIamPrincipal()

public Folder.Builder clearCreatorIamPrincipal()

Output only. The IAM principal identifier of the creator of the Folder.

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

Returns
Type Description
Folder.Builder

This builder for chaining.

clearDisplayName()

public Folder.Builder clearDisplayName()

Required. The Folder's user-friendly name.

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

Returns
Type Description
Folder.Builder

This builder for chaining.

clearInternalMetadata()

public Folder.Builder clearInternalMetadata()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearName()

public Folder.Builder clearName()

Identifier. The Folder's name.

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

Returns
Type Description
Folder.Builder

This builder for chaining.

clearTeamFolderName()

public Folder.Builder clearTeamFolderName()

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

string team_folder_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Folder.Builder

This builder for chaining.

clearUpdateTime()

public Folder.Builder clearUpdateTime()

Output only. The timestamp of when the Folder was last updated.

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

Returns
Type Description
Folder.Builder

getContainingFolder()

public String getContainingFolder()

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.

string containing_folder = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The containingFolder.

getContainingFolderBytes()

public ByteString getContainingFolderBytes()

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.

string containing_folder = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for containingFolder.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp of 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. The timestamp of 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. The timestamp of when the Folder was created.

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

Returns
Type Description
TimestampOrBuilder

getCreatorIamPrincipal()

public String getCreatorIamPrincipal()

Output only. The IAM principal identifier of the creator of the Folder.

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

Returns
Type Description
String

The creatorIamPrincipal.

getCreatorIamPrincipalBytes()

public ByteString getCreatorIamPrincipalBytes()

Output only. The IAM principal identifier of the creator of the Folder.

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

Returns
Type Description
ByteString

The bytes for creatorIamPrincipal.

getDefaultInstanceForType()

public Folder getDefaultInstanceForType()
Returns
Type Description
Folder

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. The Folder's user-friendly name.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The Folder's user-friendly name.

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

Returns
Type Description
ByteString

The bytes for displayName.

getInternalMetadata()

public String getInternalMetadata()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The internalMetadata.

getInternalMetadataBytes()

public ByteString getInternalMetadataBytes()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for internalMetadata.

getName()

public String getName()

Identifier. The Folder's name.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The Folder's name.

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

Returns
Type Description
ByteString

The bytes for name.

getTeamFolderName()

public String getTeamFolderName()

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

string team_folder_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The teamFolderName.

getTeamFolderNameBytes()

public ByteString getTeamFolderNameBytes()

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

string team_folder_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for teamFolderName.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp of when the Folder was last updated.

.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. The timestamp of when the Folder was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp of when the Folder was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp of 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.

hasCreatorIamPrincipal()

public boolean hasCreatorIamPrincipal()

Output only. The IAM principal identifier of the creator of the Folder.

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

Returns
Type Description
boolean

Whether the creatorIamPrincipal field is set.

hasInternalMetadata()

public boolean hasInternalMetadata()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the internalMetadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp of when the Folder was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.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. The timestamp of 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

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

mergeUpdateTime(Timestamp value)

public Folder.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp of when the Folder was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Folder.Builder

setContainingFolder(String value)

public Folder.Builder setContainingFolder(String value)

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.

string containing_folder = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The containingFolder to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setContainingFolderBytes(ByteString value)

public Folder.Builder setContainingFolderBytes(ByteString value)

Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just projects/{project}/locations/{location} if this is a root Folder. This field can only be updated through MoveFolder.

string containing_folder = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for containingFolder to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Folder.Builder setCreateTime(Timestamp value)

Output only. The timestamp of 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. The timestamp of 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

setCreatorIamPrincipal(String value)

public Folder.Builder setCreatorIamPrincipal(String value)

Output only. The IAM principal identifier of the creator of the Folder.

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

Parameter
Name Description
value String

The creatorIamPrincipal to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setCreatorIamPrincipalBytes(ByteString value)

public Folder.Builder setCreatorIamPrincipalBytes(ByteString value)

Output only. The IAM principal identifier of the creator of the Folder.

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

Parameter
Name Description
value ByteString

The bytes for creatorIamPrincipal to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setDisplayName(String value)

public Folder.Builder setDisplayName(String value)

Required. The Folder's user-friendly name.

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

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)

Required. The Folder's user-friendly name.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setInternalMetadata(String value)

public Folder.Builder setInternalMetadata(String value)

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The internalMetadata to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setInternalMetadataBytes(ByteString value)

public Folder.Builder setInternalMetadataBytes(ByteString value)

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for internalMetadata to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setName(String value)

public Folder.Builder setName(String value)

Identifier. The Folder's name.

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

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)

Identifier. The Folder's name.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setTeamFolderName(String value)

public Folder.Builder setTeamFolderName(String value)

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

string team_folder_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The teamFolderName to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setTeamFolderNameBytes(ByteString value)

public Folder.Builder setTeamFolderNameBytes(ByteString value)

Output only. The resource name of the TeamFolder that this Folder is associated with. This should take the format: projects/{project}/locations/{location}/teamFolders/{teamFolder}. If this is not set, the Folder is not associated with a TeamFolder and is a UserFolder.

string team_folder_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for teamFolderName to set.

Returns
Type Description
Folder.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Folder.Builder setUpdateTime(Timestamp value)

Output only. The timestamp of when the Folder was last updated.

.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. The timestamp of when the Folder was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Folder.Builder