- 4.52.0 (latest)
- 4.51.0
- 4.50.0
- 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 static final class ExecutionConfig.Builder extends GeneratedMessageV3.Builder<ExecutionConfig.Builder> implements ExecutionConfigOrBuilder
Execution configuration for a workload.
Protobuf type google.cloud.dataproc.v1.ExecutionConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutionConfig.BuilderImplements
ExecutionConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
values |
Iterable<String> The networkTags to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The networkTags to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes of the networkTags to add. |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecutionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
build()
public ExecutionConfig build()
Returns | |
---|---|
Type | Description |
ExecutionConfig |
buildPartial()
public ExecutionConfig buildPartial()
Returns | |
---|---|
Type | Description |
ExecutionConfig |
clear()
public ExecutionConfig.Builder clear()
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
clearField(Descriptors.FieldDescriptor field)
public ExecutionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
clearIdleTtl()
public ExecutionConfig.Builder clearIdleTtl()
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 |
ExecutionConfig.Builder |
clearKmsKey()
public ExecutionConfig.Builder clearKmsKey()
Optional. The Cloud KMS key to use for encryption.
string kms_key = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
This builder for chaining. |
clearNetwork()
public ExecutionConfig.Builder clearNetwork()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ExecutionConfig.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecutionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
clearServiceAccount()
public ExecutionConfig.Builder clearServiceAccount()
Optional. Service account that used to execute workload.
string service_account = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ExecutionConfig.Builder |
This builder for chaining. |
clearTtl()
public ExecutionConfig.Builder clearTtl()
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 |
ExecutionConfig.Builder |
clone()
public ExecutionConfig.Builder clone()
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
getDefaultInstanceForType()
public ExecutionConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ExecutionConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getIdleTtlBuilder()
public Duration.Builder getIdleTtlBuilder()
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 |
Builder |
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. |
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. |
getTtlBuilder()
public Duration.Builder getTtlBuilder()
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 |
Builder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ExecutionConfig other)
public ExecutionConfig.Builder mergeFrom(ExecutionConfig other)
Parameter | |
---|---|
Name | Description |
other |
ExecutionConfig |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecutionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExecutionConfig.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
mergeIdleTtl(Duration value)
public ExecutionConfig.Builder mergeIdleTtl(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
mergeTtl(Duration value)
public ExecutionConfig.Builder mergeTtl(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecutionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
setIdleTtl(Duration value)
public ExecutionConfig.Builder setIdleTtl(Duration value)
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
setIdleTtl(Duration.Builder builderForValue)
public ExecutionConfig.Builder setIdleTtl(Duration.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
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 | |
---|---|
Name | Description |
value |
String The kmsKey to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for kmsKey to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The networkTags to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The networkUri to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for networkUri to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
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 | |
---|---|
Name | Description |
value |
String The serviceAccount to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for serviceAccount to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The stagingBucket to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for stagingBucket to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The subnetworkUri to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for subnetworkUri to set. |
Returns | |
---|---|
Type | Description |
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,
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];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
setTtl(Duration.Builder builderForValue)
public ExecutionConfig.Builder setTtl(Duration.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecutionConfig.Builder |