Package com.google.cloud.dataform.v1beta1

Class Folder

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataform.v1beta1.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
 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Folder.Builder
    Represents a Dataform Folder.

    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
    CONTAINING_FOLDER_FIELD_NUMBER
     
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    CREATOR_IAM_PRINCIPAL_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    INTERNAL_METADATA_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TEAM_FOLDER_NAME_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)
     
    String
    getContainingFolder()
    Optional.
    com.google.protobuf.ByteString
    getContainingFolderBytes()
    Optional.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    String
    getCreatorIamPrincipal()
    Output only.
    com.google.protobuf.ByteString
    getCreatorIamPrincipalBytes()
    Output only.
    static Folder
    getDefaultInstance()
     
    Folder
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Required.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Required.
    String
    getInternalMetadata()
    Output only.
    com.google.protobuf.ByteString
    getInternalMetadataBytes()
    Output only.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<Folder>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTeamFolderName()
    Output only.
    com.google.protobuf.ByteString
    getTeamFolderNameBytes()
    Output only.
    com.google.protobuf.Timestamp
    getUpdateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getUpdateTimeOrBuilder()
    Output only.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasCreatorIamPrincipal()
    Output only.
    int
    hashCode()
     
    boolean
    hasInternalMetadata()
    Output only.
    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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • CONTAINING_FOLDER_FIELD_NUMBER

      public static final int CONTAINING_FOLDER_FIELD_NUMBER
      See Also:

    • TEAM_FOLDER_NAME_FIELD_NUMBER

      public static final int TEAM_FOLDER_NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • INTERNAL_METADATA_FIELD_NUMBER

      public static final int INTERNAL_METADATA_FIELD_NUMBER
      See Also:

    • CREATOR_IAM_PRINCIPAL_FIELD_NUMBER

      public static final int CREATOR_IAM_PRINCIPAL_FIELD_NUMBER
      See Also:

  • 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()
       Identifier. The Folder's name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface FolderOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The Folder's name.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface FolderOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The Folder's user-friendly name.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface FolderOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The Folder's user-friendly name.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface FolderOrBuilder
      Returns:
      The bytes for displayName.

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

    • getContainingFolderBytes

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

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

    • getTeamFolderNameBytes

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

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

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp of 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. The timestamp of 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. The timestamp of when the Folder was last updated.
      .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. The timestamp of when the Folder was last updated.
      .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. The timestamp of when the Folder was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface FolderOrBuilder

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

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

    • getInternalMetadataBytes

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

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

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

    • getCreatorIamPrincipalBytes

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

    • 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