Class ExecutionConfig.Builder (4.17.0)

public static final class ExecutionConfig.Builder extends GeneratedMessageV3.Builder<ExecutionConfig.Builder> implements ExecutionConfigOrBuilder

Execution configuration for a workload.

Protobuf type google.cloud.dataproc.v1.ExecutionConfig

Static Methods

getDescriptor()

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

Methods

addAllNetworkTags(Iterable<String> values)

public ExecutionConfig.Builder addAllNetworkTags(Iterable<String> values)

Optional. Tags used for network traffic control.

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

Parameter
NameDescription
valuesIterable<String>

The networkTags to add.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

addNetworkTags(String value)

public ExecutionConfig.Builder addNetworkTags(String value)

Optional. Tags used for network traffic control.

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

Parameter
NameDescription
valueString

The networkTags to add.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

addNetworkTagsBytes(ByteString value)

public ExecutionConfig.Builder addNetworkTagsBytes(ByteString value)

Optional. Tags used for network traffic control.

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

Parameter
NameDescription
valueByteString

The bytes of the networkTags to add.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

build()

public ExecutionConfig build()
Returns
TypeDescription
ExecutionConfig

buildPartial()

public ExecutionConfig buildPartial()
Returns
TypeDescription
ExecutionConfig

clear()

public ExecutionConfig.Builder clear()
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ExecutionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

clearKmsKey()

public ExecutionConfig.Builder clearKmsKey()

Optional. The Cloud KMS key to use for encryption.

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

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

clearNetwork()

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

clearNetworkTags()

public ExecutionConfig.Builder clearNetworkTags()

Optional. Tags used for network traffic control.

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

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

clearNetworkUri()

public ExecutionConfig.Builder clearNetworkUri()

Optional. Network URI to connect workload to.

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

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

clearServiceAccount()

public ExecutionConfig.Builder clearServiceAccount()

Optional. Service account that used to execute workload.

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

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

clearStagingBucket()

public ExecutionConfig.Builder clearStagingBucket()

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
ExecutionConfig.Builder

This builder for chaining.

clearSubnetworkUri()

public ExecutionConfig.Builder clearSubnetworkUri()

Optional. Subnetwork URI to connect workload to.

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

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

clearTtl()

public ExecutionConfig.Builder clearTtl()

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
ExecutionConfig.Builder

clone()

public ExecutionConfig.Builder clone()
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

getDefaultInstanceForType()

public ExecutionConfig getDefaultInstanceForType()
Returns
TypeDescription
ExecutionConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExecutionConfig other)

public ExecutionConfig.Builder mergeFrom(ExecutionConfig other)
Parameter
NameDescription
otherExecutionConfig
Returns
TypeDescription
ExecutionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExecutionConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

mergeTtl(Duration value)

public ExecutionConfig.Builder mergeTtl(Duration value)

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];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ExecutionConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

setKmsKey(String value)

public ExecutionConfig.Builder setKmsKey(String value)

Optional. The Cloud KMS key to use for encryption.

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

Parameter
NameDescription
valueString

The kmsKey to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public ExecutionConfig.Builder setKmsKeyBytes(ByteString value)

Optional. The Cloud KMS key to use for encryption.

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

Parameter
NameDescription
valueByteString

The bytes for kmsKey to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setNetworkTags(int index, String value)

public ExecutionConfig.Builder setNetworkTags(int index, String value)

Optional. Tags used for network traffic control.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The networkTags to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setNetworkUri(String value)

public ExecutionConfig.Builder setNetworkUri(String value)

Optional. Network URI to connect workload to.

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

Parameter
NameDescription
valueString

The networkUri to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setNetworkUriBytes(ByteString value)

public ExecutionConfig.Builder setNetworkUriBytes(ByteString value)

Optional. Network URI to connect workload to.

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

Parameter
NameDescription
valueByteString

The bytes for networkUri to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecutionConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExecutionConfig.Builder
Overrides

setServiceAccount(String value)

public ExecutionConfig.Builder setServiceAccount(String value)

Optional. Service account that used to execute workload.

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

Parameter
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public ExecutionConfig.Builder setServiceAccountBytes(ByteString value)

Optional. Service account that used to execute workload.

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

Parameter
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setStagingBucket(String value)

public ExecutionConfig.Builder setStagingBucket(String value)

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];

Parameter
NameDescription
valueString

The stagingBucket to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setStagingBucketBytes(ByteString value)

public ExecutionConfig.Builder setStagingBucketBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for stagingBucket to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setSubnetworkUri(String value)

public ExecutionConfig.Builder setSubnetworkUri(String value)

Optional. Subnetwork URI to connect workload to.

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

Parameter
NameDescription
valueString

The subnetworkUri to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setSubnetworkUriBytes(ByteString value)

public ExecutionConfig.Builder setSubnetworkUriBytes(ByteString value)

Optional. Subnetwork URI to connect workload to.

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

Parameter
NameDescription
valueByteString

The bytes for subnetworkUri to set.

Returns
TypeDescription
ExecutionConfig.Builder

This builder for chaining.

setTtl(Duration value)

public ExecutionConfig.Builder setTtl(Duration value)

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];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ExecutionConfig.Builder

setTtl(Duration.Builder builderForValue)

public ExecutionConfig.Builder setTtl(Duration.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExecutionConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecutionConfig.Builder
Overrides