Class ExecutionConfig (4.21.0)

public final class ExecutionConfig extends GeneratedMessageV3 implements ExecutionConfigOrBuilder

Execution configuration for a workload.

Protobuf type google.cloud.dataproc.v1.ExecutionConfig

Static Fields

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_TAGS_FIELD_NUMBER

public static final int NETWORK_TAGS_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_URI_FIELD_NUMBER

public static final int NETWORK_URI_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

STAGING_BUCKET_FIELD_NUMBER

public static final int STAGING_BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_URI_FIELD_NUMBER

public static final int SUBNETWORK_URI_FIELD_NUMBER
Field Value
TypeDescription
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExecutionConfig getDefaultInstance()
Returns
TypeDescription
ExecutionConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExecutionConfig.Builder newBuilder()
Returns
TypeDescription
ExecutionConfig.Builder

newBuilder(ExecutionConfig prototype)

public static ExecutionConfig.Builder newBuilder(ExecutionConfig prototype)
Parameter
NameDescription
prototypeExecutionConfig
Returns
TypeDescription
ExecutionConfig.Builder

parseDelimitedFrom(InputStream input)

public static ExecutionConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExecutionConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecutionConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecutionConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExecutionConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExecutionConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExecutionConfig> parser()
Returns
TypeDescription
Parser<ExecutionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExecutionConfig getDefaultInstanceForType()
Returns
TypeDescription
ExecutionConfig

getKmsKey()

public String getKmsKey()

Optional. The Cloud KMS key to use for encryption.

string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Optional. The Cloud KMS key to use for encryption.

string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getNetworkCase()

public ExecutionConfig.NetworkCase getNetworkCase()
Returns
TypeDescription
ExecutionConfig.NetworkCase

getNetworkTags(int index)

public String getNetworkTags(int index)

Optional. Tags used for network traffic control.

repeated string network_tags = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The networkTags at the given index.

getNetworkTagsBytes(int index)

public ByteString getNetworkTagsBytes(int index)

Optional. Tags used for network traffic control.

repeated string network_tags = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the networkTags at the given index.

getNetworkTagsCount()

public int getNetworkTagsCount()

Optional. Tags used for network traffic control.

repeated string network_tags = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of networkTags.

getNetworkTagsList()

public ProtocolStringList getNetworkTagsList()

Optional. Tags used for network traffic control.

repeated string network_tags = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the networkTags.

getNetworkUri()

public String getNetworkUri()

Optional. Network URI to connect workload to.

string network_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The networkUri.

getNetworkUriBytes()

public ByteString getNetworkUriBytes()

Optional. Network URI to connect workload to.

string network_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for networkUri.

getParserForType()

public Parser<ExecutionConfig> getParserForType()
Returns
TypeDescription
Parser<ExecutionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceAccount()

public String getServiceAccount()

Optional. Service account that used to execute workload.

string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Optional. Service account that used to execute workload.

string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

getStagingBucket()

public String getStagingBucket()

Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.

string staging_bucket = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The stagingBucket.

getStagingBucketBytes()

public ByteString getStagingBucketBytes()

Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.

string staging_bucket = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for stagingBucket.

getSubnetworkUri()

public String getSubnetworkUri()

Optional. Subnetwork URI to connect workload to.

string subnetwork_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The subnetworkUri.

getSubnetworkUriBytes()

public ByteString getSubnetworkUriBytes()

Optional. Subnetwork URI to connect workload to.

string subnetwork_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for subnetworkUri.

getTtl()

public Duration getTtl()

Optional. The duration after which the workload will be terminated. When the workload passes this ttl, it will be unconditionally killed without waiting for ongoing work to finish. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). If both ttl and idle_ttl are specified, the conditions are treated as and OR: the workload will be terminated when it has been idle for idle_ttl or when the ttl has passed, whichever comes first. If ttl is not specified for a session, it defaults to 24h.

.google.protobuf.Duration ttl = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Duration

The ttl.

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Optional. The duration after which the workload will be terminated. When the workload passes this ttl, it will be unconditionally killed without waiting for ongoing work to finish. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). If both ttl and idle_ttl are specified, the conditions are treated as and OR: the workload will be terminated when it has been idle for idle_ttl or when the ttl has passed, whichever comes first. If ttl is not specified for a session, it defaults to 24h.

.google.protobuf.Duration ttl = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DurationOrBuilder

hasNetworkUri()

public boolean hasNetworkUri()

Optional. Network URI to connect workload to.

string network_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the networkUri field is set.

hasSubnetworkUri()

public boolean hasSubnetworkUri()

Optional. Subnetwork URI to connect workload to.

string subnetwork_uri = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the subnetworkUri field is set.

hasTtl()

public boolean hasTtl()

Optional. The duration after which the workload will be terminated. When the workload passes this ttl, it will be unconditionally killed without waiting for ongoing work to finish. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). If both ttl and idle_ttl are specified, the conditions are treated as and OR: the workload will be terminated when it has been idle for idle_ttl or when the ttl has passed, whichever comes first. If ttl is not specified for a session, it defaults to 24h.

.google.protobuf.Duration ttl = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the ttl field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExecutionConfig.Builder newBuilderForType()
Returns
TypeDescription
ExecutionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecutionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExecutionConfig.Builder toBuilder()
Returns
TypeDescription
ExecutionConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException