Package com.google.cloud.resourcemanager.v3

Class Folder

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.resourcemanager.v3.Folder
All Implemented Interfaces:
FolderOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Folder extends com.google.protobuf.GeneratedMessage implements FolderOrBuilder
 A folder in an organization's resource hierarchy, used to
 organize that organization's resources.
Protobuf type google.cloud.resourcemanager.v3.Folder
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Folder.Builder
    A folder in an organization's resource hierarchy, used to organize that organization's resources.
    static enum 
    Folder.State
    Folder lifecycle states.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    DELETE_TIME_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    ETAG_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     
    static final int
    UPDATE_TIME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    static Folder
    getDefaultInstance()
     
    Folder
    getDefaultInstanceForType()
     
    com.google.protobuf.Timestamp
    getDeleteTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getDeleteTimeOrBuilder()
    Output only.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    The folder's display name.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The folder's display name.
    String
    getEtag()
    Output only.
    com.google.protobuf.ByteString
    getEtagBytes()
    Output only.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<Folder>
    getParserForType()
     
    int
    getSerializedSize()
     
    Folder.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    com.google.protobuf.Timestamp
    getUpdateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getUpdateTimeOrBuilder()
    Output only.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasDeleteTime()
    Output only.
    int
    hashCode()
     
    boolean
    hasUpdateTime()
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Folder.Builder
    newBuilder()
     
    static Folder.Builder
    newBuilder(Folder prototype)
     
    Folder.Builder
    newBuilderForType()
     
    protected Folder.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Folder
    parseDelimitedFrom(InputStream input)
     
    static Folder
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Folder
    parseFrom(byte[] data)
     
    static Folder
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Folder
    parseFrom(com.google.protobuf.ByteString data)
     
    static Folder
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Folder
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Folder
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Folder
    parseFrom(InputStream input)
     
    static Folder
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Folder
    parseFrom(ByteBuffer data)
     
    static Folder
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Folder>
    parser()
     
    Folder.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface FolderOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface FolderOrBuilder
      Returns:
      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][google.cloud.resourcemanager.v3.Folders.MoveFolder].
      string parent = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getParent in interface FolderOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.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];
      Specified by:
      getParentBytes in interface FolderOrBuilder
      Returns:
      The bytes for parent.

    • 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}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`.
      string display_name = 3;
      Specified by:
      getDisplayName in interface FolderOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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;
      Specified by:
      getDisplayNameBytes in interface FolderOrBuilder
      Returns:
      The bytes for displayName.

    • getStateValue

      public 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];
      Specified by:
      getStateValue in interface FolderOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public 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];
      Specified by:
      getState in interface FolderOrBuilder
      Returns:
      The state.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when the folder was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface FolderOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when the folder was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface FolderOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when the folder was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface FolderOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface FolderOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when the folder was last modified.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface FolderOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when the folder was last modified.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface FolderOrBuilder

    • 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];
      Specified by:
      hasDeleteTime in interface FolderOrBuilder
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      public com.google.protobuf.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];
      Specified by:
      getDeleteTime in interface FolderOrBuilder
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getDeleteTimeOrBuilder in interface FolderOrBuilder

    • 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];
      Specified by:
      getEtag in interface FolderOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface FolderOrBuilder
      Returns:
      The bytes for etag.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Folder parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Folder parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Folder parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Folder parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Folder parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Folder parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Folder parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Folder.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Folder.Builder newBuilder()

    • newBuilder

      public static Folder.Builder newBuilder(Folder prototype)

    • toBuilder

      public Folder.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Folder.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Folder getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Folder> parser()

    • getParserForType

      public com.google.protobuf.Parser<Folder> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Folder getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder