Interface ExecutionConfigOrBuilder (4.34.0)

Version 4.34.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface ExecutionConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIdleTtl()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract ExecutionConfig.NetworkCase getNetworkCase()

Returns
Type	Description
ExecutionConfig.NetworkCase

getNetworkTags(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getNetworkTagsList()

Optional. Tags used for network traffic control.

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

Returns
Type	Description
List<String>	A list containing the networkTags.

getNetworkUri()

public abstract 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 abstract 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.

getServiceAccount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.