public final class InstantiateWorkflowTemplateRequest extends GeneratedMessageV3 implements InstantiateWorkflowTemplateRequestOrBuilder
A request to instantiate a workflow template.Protobuf type
google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest
Modifier and Type | Class and Description |
---|---|
static class |
InstantiateWorkflowTemplateRequest.Builder
A request to instantiate a workflow template.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
NAME_FIELD_NUMBER |
static int |
PARAMETERS_FIELD_NUMBER |
static int |
REQUEST_ID_FIELD_NUMBER |
static int |
VERSION_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int NAME_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField
in class GeneratedMessageV3
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
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) = { ... }
getName
in interface InstantiateWorkflowTemplateRequestOrBuilder
public 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) = { ... }
getNameBytes
in interface InstantiateWorkflowTemplateRequestOrBuilder
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];
getVersion
in interface InstantiateWorkflowTemplateRequestOrBuilder
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];
getRequestId
in interface InstantiateWorkflowTemplateRequestOrBuilder
public 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];
getRequestIdBytes
in interface InstantiateWorkflowTemplateRequestOrBuilder
public int getParametersCount()
InstantiateWorkflowTemplateRequestOrBuilder
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];
getParametersCount
in interface InstantiateWorkflowTemplateRequestOrBuilder
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];
containsParameters
in interface InstantiateWorkflowTemplateRequestOrBuilder
@Deprecated public Map<String,String> getParameters()
getParametersMap()
instead.getParameters
in interface InstantiateWorkflowTemplateRequestOrBuilder
public 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];
getParametersMap
in interface InstantiateWorkflowTemplateRequestOrBuilder
public 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];
getParametersOrDefault
in interface InstantiateWorkflowTemplateRequestOrBuilder
public 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];
getParametersOrThrow
in interface InstantiateWorkflowTemplateRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input) throws IOException
IOException
public static InstantiateWorkflowTemplateRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static InstantiateWorkflowTemplateRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static InstantiateWorkflowTemplateRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static InstantiateWorkflowTemplateRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public InstantiateWorkflowTemplateRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static InstantiateWorkflowTemplateRequest.Builder newBuilder()
public static InstantiateWorkflowTemplateRequest.Builder newBuilder(InstantiateWorkflowTemplateRequest prototype)
public InstantiateWorkflowTemplateRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected InstantiateWorkflowTemplateRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static InstantiateWorkflowTemplateRequest getDefaultInstance()
public static Parser<InstantiateWorkflowTemplateRequest> parser()
public Parser<InstantiateWorkflowTemplateRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public InstantiateWorkflowTemplateRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.