Class LaunchTemplateParameters

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.LaunchTemplateParameters
All Implemented Interfaces:
LaunchTemplateParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class LaunchTemplateParameters extends com.google.protobuf.GeneratedMessage 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
See Also:
  • Field Details

    • JOB_NAME_FIELD_NUMBER

      public static final int JOB_NAME_FIELD_NUMBER
      See Also:
    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:
    • ENVIRONMENT_FIELD_NUMBER

      public static final int ENVIRONMENT_FIELD_NUMBER
      See Also:
    • UPDATE_FIELD_NUMBER

      public static final int UPDATE_FIELD_NUMBER
      See Also:
    • TRANSFORM_NAME_MAPPING_FIELD_NUMBER

      public static final int TRANSFORM_NAME_MAPPING_FIELD_NUMBER
      See Also:
  • 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
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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.
    • 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
    • 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.
    • 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.
    • 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
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static LaunchTemplateParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LaunchTemplateParameters parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LaunchTemplateParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LaunchTemplateParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

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

      public static LaunchTemplateParameters.Builder newBuilder()
    • newBuilder

      public static LaunchTemplateParameters.Builder newBuilder(LaunchTemplateParameters prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected LaunchTemplateParameters.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static LaunchTemplateParameters getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<LaunchTemplateParameters> parser()
    • getParserForType

      public com.google.protobuf.Parser<LaunchTemplateParameters> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

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