Class InstantiateWorkflowTemplateRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder>
      • getDefaultInstanceForType

        public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public InstantiateWorkflowTemplateRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public InstantiateWorkflowTemplateRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<InstantiateWorkflowTemplateRequest.Builder>
      • getName

        public 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) = { ... }
        Specified by:
        getName in interface InstantiateWorkflowTemplateRequestOrBuilder
        Returns:
        The name.
      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface InstantiateWorkflowTemplateRequestOrBuilder
        Returns:
        The bytes for name.
      • setName

        public InstantiateWorkflowTemplateRequest.Builder setName​(String value)
         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) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public InstantiateWorkflowTemplateRequest.Builder clearName()
         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:
        This builder for chaining.
      • setNameBytes

        public InstantiateWorkflowTemplateRequest.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getVersion

        public 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];
        Specified by:
        getVersion in interface InstantiateWorkflowTemplateRequestOrBuilder
        Returns:
        The version.
      • setVersion

        public InstantiateWorkflowTemplateRequest.Builder setVersion​(int value)
         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];
        Parameters:
        value - The version to set.
        Returns:
        This builder for chaining.
      • clearVersion

        public InstantiateWorkflowTemplateRequest.Builder clearVersion()
         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:
        This builder for chaining.
      • getRequestId

        public 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];
        Specified by:
        getRequestId in interface InstantiateWorkflowTemplateRequestOrBuilder
        Returns:
        The requestId.
      • getRequestIdBytes

        public 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];
        Specified by:
        getRequestIdBytes in interface InstantiateWorkflowTemplateRequestOrBuilder
        Returns:
        The bytes for requestId.
      • setRequestId

        public InstantiateWorkflowTemplateRequest.Builder setRequestId​(String value)
         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];
        Parameters:
        value - The requestId to set.
        Returns:
        This builder for chaining.
      • clearRequestId

        public InstantiateWorkflowTemplateRequest.Builder clearRequestId()
         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:
        This builder for chaining.
      • setRequestIdBytes

        public InstantiateWorkflowTemplateRequest.Builder setRequestIdBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for requestId to set.
        Returns:
        This builder for chaining.
      • containsParameters

        public 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];
        Specified by:
        containsParameters in interface InstantiateWorkflowTemplateRequestOrBuilder
      • removeParameters

        public InstantiateWorkflowTemplateRequest.Builder removeParameters​(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];
      • getMutableParameters

        @Deprecated
        public Map<String,​String> getMutableParameters()
        Deprecated.
        Use alternate mutation accessors instead.
      • putParameters

        public InstantiateWorkflowTemplateRequest.Builder putParameters​(String key,
                                                                        String value)
         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];
      • putAllParameters

        public InstantiateWorkflowTemplateRequest.Builder putAllParameters​(Map<String,​String> values)
         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];