Interface FolderOrBuilder (0.84.0)

public interface FolderOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContainingFolder()

public abstract 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 abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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.

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getName()

Identifier. The Folder's name.

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract 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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.