Class LaunchTemplateParameters.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
com.google.dataflow.v1beta3.LaunchTemplateParameters.Builder
All Implemented Interfaces:
LaunchTemplateParametersOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
LaunchTemplateParameters

public static final class LaunchTemplateParameters.Builder extends com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder> implements LaunchTemplateParametersOrBuilder
 Parameters to provide to the template being launched. Note that the
 [metadata in the pipeline code]
 (https://cloud.google.com/dataflow/docs/guides/templates/creating-templates#metadata)
 determines which runtime parameters are valid.
 
Protobuf type google.dataflow.v1beta3.LaunchTemplateParameters
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.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.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
    • getDefaultInstanceForType

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

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

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

      public LaunchTemplateParameters.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LaunchTemplateParameters.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<LaunchTemplateParameters.Builder>
    • mergeFrom

      public LaunchTemplateParameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LaunchTemplateParameters.Builder>
      Throws:
      IOException
    • getJobName

      public String getJobName()
       Required. The job name to use for the created job.
      
       The name must match the regular expression
       `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
       
      string job_name = 1;
      Specified by:
      getJobName in interface LaunchTemplateParametersOrBuilder
      Returns:
      The jobName.
    • getJobNameBytes

      public com.google.protobuf.ByteString getJobNameBytes()
       Required. The job name to use for the created job.
      
       The name must match the regular expression
       `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
       
      string job_name = 1;
      Specified by:
      getJobNameBytes in interface LaunchTemplateParametersOrBuilder
      Returns:
      The bytes for jobName.
    • setJobName

      public LaunchTemplateParameters.Builder setJobName(String value)
       Required. The job name to use for the created job.
      
       The name must match the regular expression
       `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
       
      string job_name = 1;
      Parameters:
      value - The jobName to set.
      Returns:
      This builder for chaining.
    • clearJobName

      public LaunchTemplateParameters.Builder clearJobName()
       Required. The job name to use for the created job.
      
       The name must match the regular expression
       `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
       
      string job_name = 1;
      Returns:
      This builder for chaining.
    • setJobNameBytes

      public LaunchTemplateParameters.Builder setJobNameBytes(com.google.protobuf.ByteString value)
       Required. The job name to use for the created job.
      
       The name must match the regular expression
       `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
       
      string job_name = 1;
      Parameters:
      value - The bytes for jobName to set.
      Returns:
      This builder for chaining.
    • getParametersCount

      public int getParametersCount()
      Description copied from interface: LaunchTemplateParametersOrBuilder
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
      Specified by:
      getParametersCount in interface LaunchTemplateParametersOrBuilder
    • containsParameters

      public boolean containsParameters(String key)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
      Specified by:
      containsParameters in interface LaunchTemplateParametersOrBuilder
    • getParameters

      @Deprecated public Map<String,String> getParameters()
      Deprecated.
      Use getParametersMap() instead.
      Specified by:
      getParameters in interface LaunchTemplateParametersOrBuilder
    • getParametersMap

      public Map<String,String> getParametersMap()
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
      Specified by:
      getParametersMap in interface LaunchTemplateParametersOrBuilder
    • getParametersOrDefault

      public String getParametersOrDefault(String key, String defaultValue)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
      Specified by:
      getParametersOrDefault in interface LaunchTemplateParametersOrBuilder
    • getParametersOrThrow

      public String getParametersOrThrow(String key)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
      Specified by:
      getParametersOrThrow in interface LaunchTemplateParametersOrBuilder
    • clearParameters

      public LaunchTemplateParameters.Builder clearParameters()
    • removeParameters

      public LaunchTemplateParameters.Builder removeParameters(String key)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
    • getMutableParameters

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

      public LaunchTemplateParameters.Builder putParameters(String key, String value)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
    • putAllParameters

      public LaunchTemplateParameters.Builder putAllParameters(Map<String,String> values)
       The runtime parameters to pass to the job.
       
      map<string, string> parameters = 2;
    • hasEnvironment

      public boolean hasEnvironment()
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
      Specified by:
      hasEnvironment in interface LaunchTemplateParametersOrBuilder
      Returns:
      Whether the environment field is set.
    • getEnvironment

      public RuntimeEnvironment getEnvironment()
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
      Specified by:
      getEnvironment in interface LaunchTemplateParametersOrBuilder
      Returns:
      The environment.
    • setEnvironment

       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
    • setEnvironment

      public LaunchTemplateParameters.Builder setEnvironment(RuntimeEnvironment.Builder builderForValue)
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
    • mergeEnvironment

      public LaunchTemplateParameters.Builder mergeEnvironment(RuntimeEnvironment value)
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
    • clearEnvironment

      public LaunchTemplateParameters.Builder clearEnvironment()
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
    • getEnvironmentBuilder

      public RuntimeEnvironment.Builder getEnvironmentBuilder()
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
    • getEnvironmentOrBuilder

      public RuntimeEnvironmentOrBuilder getEnvironmentOrBuilder()
       The runtime environment for the job.
       
      .google.dataflow.v1beta3.RuntimeEnvironment environment = 3;
      Specified by:
      getEnvironmentOrBuilder in interface LaunchTemplateParametersOrBuilder
    • getUpdate

      public boolean getUpdate()
       If set, replace the existing pipeline with the name specified by jobName
       with this pipeline, preserving state.
       
      bool update = 4;
      Specified by:
      getUpdate in interface LaunchTemplateParametersOrBuilder
      Returns:
      The update.
    • setUpdate

      public LaunchTemplateParameters.Builder setUpdate(boolean value)
       If set, replace the existing pipeline with the name specified by jobName
       with this pipeline, preserving state.
       
      bool update = 4;
      Parameters:
      value - The update to set.
      Returns:
      This builder for chaining.
    • clearUpdate

      public LaunchTemplateParameters.Builder clearUpdate()
       If set, replace the existing pipeline with the name specified by jobName
       with this pipeline, preserving state.
       
      bool update = 4;
      Returns:
      This builder for chaining.
    • getTransformNameMappingCount

      public int getTransformNameMappingCount()
      Description copied from interface: LaunchTemplateParametersOrBuilder
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
      Specified by:
      getTransformNameMappingCount in interface LaunchTemplateParametersOrBuilder
    • containsTransformNameMapping

      public boolean containsTransformNameMapping(String key)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
      Specified by:
      containsTransformNameMapping in interface LaunchTemplateParametersOrBuilder
    • getTransformNameMapping

      @Deprecated public Map<String,String> getTransformNameMapping()
      Deprecated.
      Specified by:
      getTransformNameMapping in interface LaunchTemplateParametersOrBuilder
    • getTransformNameMappingMap

      public Map<String,String> getTransformNameMappingMap()
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
      Specified by:
      getTransformNameMappingMap in interface LaunchTemplateParametersOrBuilder
    • getTransformNameMappingOrDefault

      public String getTransformNameMappingOrDefault(String key, String defaultValue)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
      Specified by:
      getTransformNameMappingOrDefault in interface LaunchTemplateParametersOrBuilder
    • getTransformNameMappingOrThrow

      public String getTransformNameMappingOrThrow(String key)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
      Specified by:
      getTransformNameMappingOrThrow in interface LaunchTemplateParametersOrBuilder
    • clearTransformNameMapping

      public LaunchTemplateParameters.Builder clearTransformNameMapping()
    • removeTransformNameMapping

      public LaunchTemplateParameters.Builder removeTransformNameMapping(String key)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
    • getMutableTransformNameMapping

      @Deprecated public Map<String,String> getMutableTransformNameMapping()
      Deprecated.
      Use alternate mutation accessors instead.
    • putTransformNameMapping

      public LaunchTemplateParameters.Builder putTransformNameMapping(String key, String value)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;
    • putAllTransformNameMapping

      public LaunchTemplateParameters.Builder putAllTransformNameMapping(Map<String,String> values)
       Only applicable when updating a pipeline. Map of transform name prefixes of
       the job to be replaced to the corresponding name prefixes of the new job.
       
      map<string, string> transform_name_mapping = 5;