com.google.cloud.dataproc.v1.TemplateParameterOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dataproc-v1 Show documentation
Show all versions of proto-google-cloud-dataproc-v1 Show documentation
PROTO library for proto-google-cloud-dataproc-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/workflow_templates.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dataproc.v1;
public interface TemplateParameterOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.TemplateParameter)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Parameter name.
* The parameter name is used as the key, and paired with the
* parameter value, which are passed to the template when the template
* is instantiated.
* The name must contain only capital letters (A-Z), numbers (0-9), and
* underscores (_), and must not start with a number. The maximum length is
* 40 characters.
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Required. Parameter name.
* The parameter name is used as the key, and paired with the
* parameter value, which are passed to the template when the template
* is instantiated.
* The name must contain only capital letters (A-Z), numbers (0-9), and
* underscores (_), and must not start with a number. The maximum length is
* 40 characters.
*
*
* string name = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. Paths to all fields that the parameter replaces.
* A field is allowed to appear in at most one parameter's list of field
* paths.
*
* A field path is similar in syntax to a
* [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a
* field path that references the zone field of a workflow template's cluster
* selector would be specified as `placement.clusterSelector.zone`.
*
* Also, field paths can reference fields using the following syntax:
*
* * Values in maps can be referenced by key:
* * labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * placement.managedCluster.labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * jobs['step-id'].labels['key']
*
* * Jobs in the jobs list can be referenced by step-id:
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * jobs['step-id'].hiveJob.queryFileUri
* * jobs['step-id'].pySparkJob.mainPythonFileUri
* * jobs['step-id'].hadoopJob.jarFileUris[0]
* * jobs['step-id'].hadoopJob.archiveUris[0]
* * jobs['step-id'].hadoopJob.fileUris[0]
* * jobs['step-id'].pySparkJob.pythonFileUris[0]
*
* * Items in repeated fields can be referenced by a zero-based index:
* * jobs['step-id'].sparkJob.args[0]
*
* * Other examples:
* * jobs['step-id'].hadoopJob.properties['key']
* * jobs['step-id'].hadoopJob.args[0]
* * jobs['step-id'].hiveJob.scriptVariables['key']
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * placement.clusterSelector.zone
*
* It may not be possible to parameterize maps and repeated fields in their
* entirety since only individual map values and individual items in repeated
* fields can be referenced. For example, the following field paths are
* invalid:
*
* - placement.clusterSelector.clusterLabels
* - jobs['step-id'].sparkJob.args
*
*
* repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return A list containing the fields.
*/
java.util.List getFieldsList();
/**
*
*
*
* Required. Paths to all fields that the parameter replaces.
* A field is allowed to appear in at most one parameter's list of field
* paths.
*
* A field path is similar in syntax to a
* [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a
* field path that references the zone field of a workflow template's cluster
* selector would be specified as `placement.clusterSelector.zone`.
*
* Also, field paths can reference fields using the following syntax:
*
* * Values in maps can be referenced by key:
* * labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * placement.managedCluster.labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * jobs['step-id'].labels['key']
*
* * Jobs in the jobs list can be referenced by step-id:
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * jobs['step-id'].hiveJob.queryFileUri
* * jobs['step-id'].pySparkJob.mainPythonFileUri
* * jobs['step-id'].hadoopJob.jarFileUris[0]
* * jobs['step-id'].hadoopJob.archiveUris[0]
* * jobs['step-id'].hadoopJob.fileUris[0]
* * jobs['step-id'].pySparkJob.pythonFileUris[0]
*
* * Items in repeated fields can be referenced by a zero-based index:
* * jobs['step-id'].sparkJob.args[0]
*
* * Other examples:
* * jobs['step-id'].hadoopJob.properties['key']
* * jobs['step-id'].hadoopJob.args[0]
* * jobs['step-id'].hiveJob.scriptVariables['key']
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * placement.clusterSelector.zone
*
* It may not be possible to parameterize maps and repeated fields in their
* entirety since only individual map values and individual items in repeated
* fields can be referenced. For example, the following field paths are
* invalid:
*
* - placement.clusterSelector.clusterLabels
* - jobs['step-id'].sparkJob.args
*
*
* repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The count of fields.
*/
int getFieldsCount();
/**
*
*
*
* Required. Paths to all fields that the parameter replaces.
* A field is allowed to appear in at most one parameter's list of field
* paths.
*
* A field path is similar in syntax to a
* [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a
* field path that references the zone field of a workflow template's cluster
* selector would be specified as `placement.clusterSelector.zone`.
*
* Also, field paths can reference fields using the following syntax:
*
* * Values in maps can be referenced by key:
* * labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * placement.managedCluster.labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * jobs['step-id'].labels['key']
*
* * Jobs in the jobs list can be referenced by step-id:
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * jobs['step-id'].hiveJob.queryFileUri
* * jobs['step-id'].pySparkJob.mainPythonFileUri
* * jobs['step-id'].hadoopJob.jarFileUris[0]
* * jobs['step-id'].hadoopJob.archiveUris[0]
* * jobs['step-id'].hadoopJob.fileUris[0]
* * jobs['step-id'].pySparkJob.pythonFileUris[0]
*
* * Items in repeated fields can be referenced by a zero-based index:
* * jobs['step-id'].sparkJob.args[0]
*
* * Other examples:
* * jobs['step-id'].hadoopJob.properties['key']
* * jobs['step-id'].hadoopJob.args[0]
* * jobs['step-id'].hiveJob.scriptVariables['key']
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * placement.clusterSelector.zone
*
* It may not be possible to parameterize maps and repeated fields in their
* entirety since only individual map values and individual items in repeated
* fields can be referenced. For example, the following field paths are
* invalid:
*
* - placement.clusterSelector.clusterLabels
* - jobs['step-id'].sparkJob.args
*
*
* repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @param index The index of the element to return.
* @return The fields at the given index.
*/
java.lang.String getFields(int index);
/**
*
*
*
* Required. Paths to all fields that the parameter replaces.
* A field is allowed to appear in at most one parameter's list of field
* paths.
*
* A field path is similar in syntax to a
* [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a
* field path that references the zone field of a workflow template's cluster
* selector would be specified as `placement.clusterSelector.zone`.
*
* Also, field paths can reference fields using the following syntax:
*
* * Values in maps can be referenced by key:
* * labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * placement.managedCluster.labels['key']
* * placement.clusterSelector.clusterLabels['key']
* * jobs['step-id'].labels['key']
*
* * Jobs in the jobs list can be referenced by step-id:
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * jobs['step-id'].hiveJob.queryFileUri
* * jobs['step-id'].pySparkJob.mainPythonFileUri
* * jobs['step-id'].hadoopJob.jarFileUris[0]
* * jobs['step-id'].hadoopJob.archiveUris[0]
* * jobs['step-id'].hadoopJob.fileUris[0]
* * jobs['step-id'].pySparkJob.pythonFileUris[0]
*
* * Items in repeated fields can be referenced by a zero-based index:
* * jobs['step-id'].sparkJob.args[0]
*
* * Other examples:
* * jobs['step-id'].hadoopJob.properties['key']
* * jobs['step-id'].hadoopJob.args[0]
* * jobs['step-id'].hiveJob.scriptVariables['key']
* * jobs['step-id'].hadoopJob.mainJarFileUri
* * placement.clusterSelector.zone
*
* It may not be possible to parameterize maps and repeated fields in their
* entirety since only individual map values and individual items in repeated
* fields can be referenced. For example, the following field paths are
* invalid:
*
* - placement.clusterSelector.clusterLabels
* - jobs['step-id'].sparkJob.args
*
*
* repeated string fields = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @param index The index of the value to return.
* @return The bytes of the fields at the given index.
*/
com.google.protobuf.ByteString getFieldsBytes(int index);
/**
*
*
*
* Optional. Brief description of the parameter.
* Must not exceed 1024 characters.
*
*
* string description = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. Brief description of the parameter.
* Must not exceed 1024 characters.
*
*
* string description = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Optional. Validation rules to be applied to this parameter's value.
*
*
*
* .google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the validation field is set.
*/
boolean hasValidation();
/**
*
*
*
* Optional. Validation rules to be applied to this parameter's value.
*
*
*
* .google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The validation.
*/
com.google.cloud.dataproc.v1.ParameterValidation getValidation();
/**
*
*
*
* Optional. Validation rules to be applied to this parameter's value.
*
*
*
* .google.cloud.dataproc.v1.ParameterValidation validation = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.ParameterValidationOrBuilder getValidationOrBuilder();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy