Class ExecutionConfig (4.41.0)

public final class ExecutionConfig extends GeneratedMessageV3 implements ExecutionConfigOrBuilder

Execution configuration for a workload.

Protobuf type google.cloud.dataproc.v1.ExecutionConfig

Static Fields

IDLE_TTL_FIELD_NUMBER

public static final int IDLE_TTL_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_TAGS_FIELD_NUMBER

public static final int NETWORK_TAGS_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_URI_FIELD_NUMBER

public static final int NETWORK_URI_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

STAGING_BUCKET_FIELD_NUMBER

public static final int STAGING_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_URI_FIELD_NUMBER

public static final int SUBNETWORK_URI_FIELD_NUMBER
Field Value
Type Description
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecutionConfig getDefaultInstance()
Returns
Type Description
ExecutionConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExecutionConfig.Builder newBuilder()
Returns
Type Description
ExecutionConfig.Builder

newBuilder(ExecutionConfig prototype)

public static ExecutionConfig.Builder newBuilder(ExecutionConfig prototype)
Parameter
Name Description
prototype ExecutionConfig
Returns
Type Description
ExecutionConfig.Builder

parseDelimitedFrom(InputStream input)

public static ExecutionConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecutionConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecutionConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecutionConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecutionConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecutionConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecutionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecutionConfig> parser()
Returns
Type Description
Parser<ExecutionConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExecutionConfig getDefaultInstanceForType()
Returns
Type Description
ExecutionConfig

getIdleTtl()

public Duration getIdleTtl()

Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

.google.protobuf.Duration idle_ttl = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The idleTtl.

getIdleTtlOrBuilder()

public DurationOrBuilder getIdleTtlOrBuilder()

Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

.google.protobuf.Duration idle_ttl = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getKmsKey()

public String getKmsKey()

Optional. The Cloud KMS key to use for encryption.

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

Returns
Type Description
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
Type Description
ByteString

The bytes for kmsKey.

getNetworkCase()

public ExecutionConfig.NetworkCase getNetworkCase()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
String

The networkUri.

getNetworkUriBytes()

public ByteString getNetworkUriBytes()

Optional. Network URI to connect workload to.

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

Returns
Type Description
ByteString

The bytes for networkUri.

getParserForType()

public Parser<ExecutionConfig> getParserForType()
Returns
Type Description
Parser<ExecutionConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String getServiceAccount()

Optional. Service account that used to execute workload.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
String

The subnetworkUri.

getSubnetworkUriBytes()

public ByteString getSubnetworkUriBytes()

Optional. Subnetwork URI to connect workload to.

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

Returns
Type Description
ByteString

The bytes for subnetworkUri.

getTtl()

public Duration getTtl()

Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration. When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

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

Returns
Type Description
Duration

The ttl.

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration. When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

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

Returns
Type Description
DurationOrBuilder

hasIdleTtl()

public boolean hasIdleTtl()

Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

.google.protobuf.Duration idle_ttl = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the idleTtl field is set.

hasNetworkUri()

public boolean hasNetworkUri()

Optional. Network URI to connect workload to.

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

Returns
Type Description
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
Type Description
boolean

Whether the subnetworkUri field is set.

hasTtl()

public boolean hasTtl()

Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration. When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.

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

Returns
Type Description
boolean

Whether the ttl field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecutionConfig.Builder newBuilderForType()
Returns
Type Description
ExecutionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecutionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecutionConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExecutionConfig.Builder toBuilder()
Returns
Type Description
ExecutionConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException