Console
    Start free

    Google Cloud Dataform V1 Client - Class Folder (0.11.0)

    Reference documentation and code samples for the Google Cloud Dataform V1 Client class Folder.

    Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.

    Generated from protobuf message google.cloud.dataform.v1.Folder

    Namespace

    Google \ Cloud \ Dataform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Identifier. The Folder's name.

    ↳ display_name
    string

    Required. The Folder's user-friendly name.

    ↳ containing_folder
    string

    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.

    ↳ team_folder_name
    string

    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.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The timestamp of when the Folder was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The timestamp of when the Folder was last updated.

    ↳ internal_metadata
    string

    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.

    ↳ creator_iam_principal
    string

    Output only. The IAM principal identifier of the creator of the Folder.

    getName

    Identifier. The Folder's name.

    Returns
    Type
    Description
    string

    setName

    Identifier. The Folder's name.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    Required. The Folder's user-friendly name.

    Returns
    Type
    Description
    string

    setDisplayName

    Required. The Folder's user-friendly name.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setContainingFolder

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setTeamFolderName

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The timestamp of when the Folder was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The timestamp of when the Folder was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The timestamp of when the Folder was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The timestamp of when the Folder was last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    hasInternalMetadata

    clearInternalMetadata

    setInternalMetadata

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreatorIamPrincipal

    Output only. The IAM principal identifier of the creator of the Folder.

    Returns
    Type
    Description
    string

    hasCreatorIamPrincipal

    clearCreatorIamPrincipal

    setCreatorIamPrincipal

    Output only. The IAM principal identifier of the creator of the Folder.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: