Package com.google.cloud.dataproc.v1

Interface InstantiateWorkflowTemplateRequestOrBuilder

    • Method Detail

      • getName

        String getName()
         Required. The resource name of the workflow template, as described
 in https://cloud.google.com/apis/design/resource_names.

 * For `projects.regions.workflowTemplates.instantiate`, the resource name
 of the template has the following format:
   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

 * For `projects.locations.workflowTemplates.instantiate`, the resource name
   of the template has the following format:
   `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of the workflow template, as described
 in https://cloud.google.com/apis/design/resource_names.

 * For `projects.regions.workflowTemplates.instantiate`, the resource name
 of the template has the following format:
   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`

 * For `projects.locations.workflowTemplates.instantiate`, the resource name
   of the template has the following format:
   `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for name.

      • getVersion

        int getVersion()
         Optional. The version of workflow template to instantiate. If specified,
 the workflow will be instantiated only if the current version of
 the workflow template has the supplied version.

 This option cannot be used to instantiate a previous version of
 workflow template.
        int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The version.

      • getRequestId

        String getRequestId()
         Optional. A tag that prevents multiple concurrent workflow
 instances with the same tag from running. This mitigates risk of
 concurrent instances started due to retries.

 It is recommended to always set this value to a
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).

 The tag must contain only letters (a-z, A-Z), numbers (0-9),
 underscores (_), and hyphens (-). The maximum length is 40 characters.
        string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         Optional. A tag that prevents multiple concurrent workflow
 instances with the same tag from running. This mitigates risk of
 concurrent instances started due to retries.

 It is recommended to always set this value to a
 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).

 The tag must contain only letters (a-z, A-Z), numbers (0-9),
 underscores (_), and hyphens (-). The maximum length is 40 characters.
        string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for requestId.

      • getParametersCount

        int getParametersCount()
         Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
        map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

      • containsParameters

        boolean containsParameters​(String key)
         Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
        map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersMap

        Map<String,​String> getParametersMap()
         Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
        map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersOrDefault

        String getParametersOrDefault​(String key,
                              String defaultValue)
         Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
        map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getParametersOrThrow

        String getParametersOrThrow​(String key)
         Optional. Map from parameter names to values that should be used for those
 parameters. Values may not exceed 1000 characters.
        map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];