Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getFolder

Retrieves a Folder identified by the supplied resource name. Valid Folder resource names have the format folders/{folder_id} (for example, folders/1234). The caller must have resourcemanager.folders.get permission on the identified folder.

Using getFolder

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFolder(args: GetFolderArgs, opts?: InvokeOptions): Promise<GetFolderResult>
function getFolderOutput(args: GetFolderOutputArgs, opts?: InvokeOptions): Output<GetFolderResult>
def get_folder(folder_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetFolderResult
def get_folder_output(folder_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetFolderResult]
func LookupFolder(ctx *Context, args *LookupFolderArgs, opts ...InvokeOption) (*LookupFolderResult, error)
func LookupFolderOutput(ctx *Context, args *LookupFolderOutputArgs, opts ...InvokeOption) LookupFolderResultOutput

> Note: This function is named LookupFolder in the Go SDK.

public static class GetFolder 
{
    public static Task<GetFolderResult> InvokeAsync(GetFolderArgs args, InvokeOptions? opts = null)
    public static Output<GetFolderResult> Invoke(GetFolderInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:cloudresourcemanager/v2:getFolder
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FolderId string
FolderId string
folderId String
folderId string
folderId String

getFolder Result

The following output properties are available:

CreateTime string

Timestamp when the Folder was created. Assigned by the server.

DisplayName string

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

LifecycleState string

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

Name string

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

Parent string

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

CreateTime string

Timestamp when the Folder was created. Assigned by the server.

DisplayName string

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

LifecycleState string

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

Name string

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

Parent string

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

createTime String

Timestamp when the Folder was created. Assigned by the server.

displayName String

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

lifecycleState String

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

name String

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

parent String

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

createTime string

Timestamp when the Folder was created. Assigned by the server.

displayName string

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

lifecycleState string

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

name string

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

parent string

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

create_time str

Timestamp when the Folder was created. Assigned by the server.

display_name str

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

lifecycle_state str

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

name str

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

parent str

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

createTime String

Timestamp when the Folder was created. Assigned by the server.

displayName String

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.

lifecycleState String

The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.

name String

The resource name of the Folder. Its format is folders/{folder_id}, for example: "folders/1234".

parent String

The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0