Google Cloud Native v0.31.1, Jul 20 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.dataflow/v1b3.getTemplate

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

Using getTemplate

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 getTemplate(args: GetTemplateArgs, opts?: InvokeOptions): Promise<GetTemplateResult>
function getTemplateOutput(args: GetTemplateOutputArgs, opts?: InvokeOptions): Output<GetTemplateResult>

def get_template(gcs_path: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 view: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTemplateResult
def get_template_output(gcs_path: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 view: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTemplateResult]

func LookupTemplate(ctx *Context, args *LookupTemplateArgs, opts ...InvokeOption) (*LookupTemplateResult, error)
func LookupTemplateOutput(ctx *Context, args *LookupTemplateOutputArgs, opts ...InvokeOption) LookupTemplateResultOutput

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

public static class GetTemplate 
{
    public static Task<GetTemplateResult> InvokeAsync(GetTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetTemplateResult> Invoke(GetTemplateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:dataflow/v1b3:getTemplate
  arguments:
    # arguments dictionary

The following arguments are supported:

GcsPath string
Location string
Project string
View string

GcsPath string
Location string
Project string
View string

gcsPath String
location String
project String
view String

gcsPath string
location string
project string
view string

gcs_path str
location str
project str
view str

gcsPath String
location String
project String
view String

getTemplate Result

The following output properties are available:

Metadata Pulumi.GoogleNative.Dataflow.V1b3.Outputs.TemplateMetadataResponse: The template metadata describing the template name, available parameters, etc.
RuntimeMetadata Pulumi.GoogleNative.Dataflow.V1b3.Outputs.RuntimeMetadataResponse: Describes the runtime metadata with SDKInfo and available parameters.
Status Pulumi.GoogleNative.Dataflow.V1b3.Outputs.StatusResponse: The status of the get template request. Any problems with the request will be indicated in the error_details.
TemplateType string: Template Type.

Metadata TemplateMetadataResponse: The template metadata describing the template name, available parameters, etc.
RuntimeMetadata RuntimeMetadataResponse: Describes the runtime metadata with SDKInfo and available parameters.
Status StatusResponse: The status of the get template request. Any problems with the request will be indicated in the error_details.
TemplateType string: Template Type.

metadata TemplateMetadataResponse: The template metadata describing the template name, available parameters, etc.
runtimeMetadata RuntimeMetadataResponse: Describes the runtime metadata with SDKInfo and available parameters.
status StatusResponse: The status of the get template request. Any problems with the request will be indicated in the error_details.
templateType String: Template Type.

metadata TemplateMetadataResponse: The template metadata describing the template name, available parameters, etc.
runtimeMetadata RuntimeMetadataResponse: Describes the runtime metadata with SDKInfo and available parameters.
status StatusResponse: The status of the get template request. Any problems with the request will be indicated in the error_details.
templateType string: Template Type.

metadata TemplateMetadataResponse: The template metadata describing the template name, available parameters, etc.
runtime_metadata RuntimeMetadataResponse: Describes the runtime metadata with SDKInfo and available parameters.
status StatusResponse: The status of the get template request. Any problems with the request will be indicated in the error_details.
template_type str: Template Type.

metadata Property Map: The template metadata describing the template name, available parameters, etc.
runtimeMetadata Property Map: Describes the runtime metadata with SDKInfo and available parameters.
status Property Map: The status of the get template request. Any problems with the request will be indicated in the error_details.
templateType String: Template Type.

Supporting Types

ParameterMetadataResponse

CustomMetadata Dictionary<string, string>: Optional. Additional metadata for describing this parameter.
GroupName string: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
HelpText string: The help text to display for the parameter.
IsOptional bool: Optional. Whether the parameter is optional. Defaults to false.
Label string: The label to display for the parameter.
Name string: The name of the parameter.
ParamType string: Optional. The type of the parameter. Used for selecting input picker.
ParentName string: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
ParentTriggerValues List<string>: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
Regexes List<string>: Optional. Regexes that the parameter must match.

CustomMetadata map[string]string: Optional. Additional metadata for describing this parameter.
GroupName string: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
HelpText string: The help text to display for the parameter.
IsOptional bool: Optional. Whether the parameter is optional. Defaults to false.
Label string: The label to display for the parameter.
Name string: The name of the parameter.
ParamType string: Optional. The type of the parameter. Used for selecting input picker.
ParentName string: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
ParentTriggerValues []string: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
Regexes []string: Optional. Regexes that the parameter must match.

customMetadata Map<String,String>: Optional. Additional metadata for describing this parameter.
groupName String: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
helpText String: The help text to display for the parameter.
isOptional Boolean: Optional. Whether the parameter is optional. Defaults to false.
label String: The label to display for the parameter.
name String: The name of the parameter.
paramType String: Optional. The type of the parameter. Used for selecting input picker.
parentName String: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
parentTriggerValues List<String>: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
regexes List<String>: Optional. Regexes that the parameter must match.

customMetadata {[key: string]: string}: Optional. Additional metadata for describing this parameter.
groupName string: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
helpText string: The help text to display for the parameter.
isOptional boolean: Optional. Whether the parameter is optional. Defaults to false.
label string: The label to display for the parameter.
name string: The name of the parameter.
paramType string: Optional. The type of the parameter. Used for selecting input picker.
parentName string: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
parentTriggerValues string[]: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
regexes string[]: Optional. Regexes that the parameter must match.

custom_metadata Mapping[str, str]: Optional. Additional metadata for describing this parameter.
group_name str: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
help_text str: The help text to display for the parameter.
is_optional bool: Optional. Whether the parameter is optional. Defaults to false.
label str: The label to display for the parameter.
name str: The name of the parameter.
param_type str: Optional. The type of the parameter. Used for selecting input picker.
parent_name str: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
parent_trigger_values Sequence[str]: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
regexes Sequence[str]: Optional. Regexes that the parameter must match.

customMetadata Map<String>: Optional. Additional metadata for describing this parameter.
groupName String: Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
helpText String: The help text to display for the parameter.
isOptional Boolean: Optional. Whether the parameter is optional. Defaults to false.
label String: The label to display for the parameter.
name String: The name of the parameter.
paramType String: Optional. The type of the parameter. Used for selecting input picker.
parentName String: Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
parentTriggerValues List<String>: Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
regexes List<String>: Optional. Regexes that the parameter must match.

RuntimeMetadataResponse

Parameters List<Pulumi.GoogleNative.Dataflow.V1b3.Inputs.ParameterMetadataResponse>: The parameters for the template.
SdkInfo Pulumi.GoogleNative.Dataflow.V1b3.Inputs.SDKInfoResponse: SDK Info for the template.

Parameters []ParameterMetadataResponse: The parameters for the template.
SdkInfo SDKInfoResponse: SDK Info for the template.

parameters List<ParameterMetadataResponse>: The parameters for the template.
sdkInfo SDKInfoResponse: SDK Info for the template.

parameters ParameterMetadataResponse[]: The parameters for the template.
sdkInfo SDKInfoResponse: SDK Info for the template.

parameters Sequence[ParameterMetadataResponse]: The parameters for the template.
sdk_info SDKInfoResponse: SDK Info for the template.

parameters List<Property Map>: The parameters for the template.
sdkInfo Property Map: SDK Info for the template.

SDKInfoResponse

Language string: The SDK Language.
Version string: Optional. The SDK version.

Language string: The SDK Language.
Version string: Optional. The SDK version.

language String: The SDK Language.
version String: Optional. The SDK version.

language string: The SDK Language.
version string: Optional. The SDK version.

language str: The SDK Language.
version str: Optional. The SDK version.

language String: The SDK Language.
version String: Optional. The SDK version.

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TemplateMetadataResponse

Description string: Optional. A description of the template.
Name string: The name of the template.
Parameters List<Pulumi.GoogleNative.Dataflow.V1b3.Inputs.ParameterMetadataResponse>: The parameters for the template.

Description string: Optional. A description of the template.
Name string: The name of the template.
Parameters []ParameterMetadataResponse: The parameters for the template.

description String: Optional. A description of the template.
name String: The name of the template.
parameters List<ParameterMetadataResponse>: The parameters for the template.

description string: Optional. A description of the template.
name string: The name of the template.
parameters ParameterMetadataResponse[]: The parameters for the template.

description str: Optional. A description of the template.
name str: The name of the template.
parameters Sequence[ParameterMetadataResponse]: The parameters for the template.

description String: Optional. A description of the template.
name String: The name of the template.
parameters List<Property Map>: The parameters for the template.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.dataflow/v1b3.getTemplate

On this page

On this page

Using getTemplate

getTemplate Result

Supporting Types

ParameterMetadataResponse

RuntimeMetadataResponse

SDKInfoResponse

StatusResponse

TemplateMetadataResponse

Package Details

On this page

On this page