Google Native

Pulumi Official
Package maintained by Pulumi
v0.22.0 published on Friday, Jul 29, 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/v3: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.

DeleteTime string

Timestamp when the folder was requested to be deleted.

DisplayName string

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}])?.

Etag string

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.

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 using MoveFolder.

State string

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

UpdateTime string

Timestamp when the folder was last modified.

CreateTime string

Timestamp when the folder was created.

DeleteTime string

Timestamp when the folder was requested to be deleted.

DisplayName string

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}])?.

Etag string

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.

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 using MoveFolder.

State string

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

UpdateTime string

Timestamp when the folder was last modified.

createTime String

Timestamp when the folder was created.

deleteTime String

Timestamp when the folder was requested to be deleted.

displayName String

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}])?.

etag String

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.

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 using MoveFolder.

state String

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

updateTime String

Timestamp when the folder was last modified.

createTime string

Timestamp when the folder was created.

deleteTime string

Timestamp when the folder was requested to be deleted.

displayName string

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}])?.

etag string

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.

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 using MoveFolder.

state string

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

updateTime string

Timestamp when the folder was last modified.

create_time str

Timestamp when the folder was created.

delete_time str

Timestamp when the folder was requested to be deleted.

display_name str

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}])?.

etag str

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.

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 using MoveFolder.

state str

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

update_time str

Timestamp when the folder was last modified.

createTime String

Timestamp when the folder was created.

deleteTime String

Timestamp when the folder was requested to be deleted.

displayName String

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}])?.

etag String

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.

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 using MoveFolder.

state String

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

updateTime String

Timestamp when the folder was last modified.

Package Details

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