com.google.cloud.resourcemanager.v3

Interface FolderOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Folder, Folder.Builder

public interface FolderOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
Timestamp	getDeleteTime() Output only.
TimestampOrBuilder	getDeleteTimeOrBuilder() Output only.
String	getDisplayName() The folder's display name.
ByteString	getDisplayNameBytes() The folder's display name.
String	getEtag() Output only.
ByteString	getEtagBytes() Output only.
String	getName() Output only.
ByteString	getNameBytes() Output only.
String	getParent() Required.
ByteString	getParentBytes() Required.
Folder.State	getState() Output only.
int	getStateValue() Output only.
Timestamp	getUpdateTime() Output only.
TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasDeleteTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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:

The bytes for name.

getParent

String getParent()

 Required. The folder's parent's resource name.
 Updates to the folder's parent must be performed using
 [MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder].
 

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

Returns:

The parent.

getParentBytes

ByteString getParentBytes()

 Required. The folder's parent's resource name.
 Updates to the folder's parent must be performed using
 [MoveFolder][google.cloud.resourcemanager.v3.Folders.MoveFolder].
 

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

Returns:

The bytes for parent.

getDisplayName

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}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.
 

string display_name = 3;

Returns:

The displayName.

getDisplayNameBytes

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}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.
 

string display_name = 3;

Returns:

The bytes for displayName.

getStateValue

int getStateValue()

 Output only. The lifecycle state of the folder.
 Updates to the state must be performed using
 [DeleteFolder][google.cloud.resourcemanager.v3.Folders.DeleteFolder] and
 [UndeleteFolder][google.cloud.resourcemanager.v3.Folders.UndeleteFolder].
 

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

Returns:

The enum numeric value on the wire for state.

getState

Folder.State getState()

 Output only. The lifecycle state of the folder.
 Updates to the state must be performed using
 [DeleteFolder][google.cloud.resourcemanager.v3.Folders.DeleteFolder] and
 [UndeleteFolder][google.cloud.resourcemanager.v3.Folders.UndeleteFolder].
 

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

Returns:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when the folder was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

Timestamp getCreateTime()

 Output only. Timestamp when the folder was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when the folder was created.
 

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when the folder was last modified.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

Timestamp getUpdateTime()

 Output only. Timestamp when the folder was last modified.
 

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when the folder was last modified.
 

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

hasDeleteTime

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:

Whether the deleteTime field is set.

getDeleteTime

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:

The deleteTime.

getDeleteTimeOrBuilder

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];

getEtag

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:

The etag.

getEtagBytes

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:

The bytes for etag.