public final class Folder extends GeneratedMessageV3 implements FolderOrBuilder
A folder in an organization's resource hierarchy, used to
organize that organization's resources.
Protobuf type google.cloud.resourcemanager.v3.Folder
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Folder getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Folder.Builder newBuilder()
Returns
newBuilder(Folder prototype)
public static Folder.Builder newBuilder(Folder prototype)
Parameter
Name | Description |
prototype | Folder
|
Returns
public static Folder parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Folder parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Folder parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Folder parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Folder parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Folder parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Folder parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Folder parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Folder parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Folder parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Folder parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Folder parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Folder> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public Folder getDefaultInstanceForType()
Returns
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
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
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()
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
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
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
getParserForType()
public Parser<Folder> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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
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
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Folder.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Folder.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Folder.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions