public final class ExecutionConfig extends GeneratedMessageV3 implements ExecutionConfigOrBuilder
Execution configuration for a workload.
Protobuf type google.cloud.dataproc.v1.ExecutionConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExecutionConfig.Builder newBuilder()
newBuilder(ExecutionConfig prototype)
public static ExecutionConfig.Builder newBuilder(ExecutionConfig prototype)
public static ExecutionConfig parseDelimitedFrom(InputStream input)
public static ExecutionConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExecutionConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecutionConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExecutionConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutionConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutionConfig parseFrom(CodedInputStream input)
public static ExecutionConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExecutionConfig parseFrom(InputStream input)
public static ExecutionConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExecutionConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecutionConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExecutionConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ExecutionConfig getDefaultInstanceForType()
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];
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()
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.
|
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.
|
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.
|
public ProtocolStringList getNetworkTagsList()
Optional. Tags used for network traffic control.
repeated string network_tags = 6 [(.google.api.field_behavior) = OPTIONAL];
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()
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()
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];
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExecutionConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecutionConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExecutionConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
