Console
    Contact Us Start free

    Google Cloud Dataproc V1 Client - Class ExecutionConfig (3.14.0)

    Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ExecutionConfig.

    Execution configuration for a workload.

    Generated from protobuf message google.cloud.dataproc.v1.ExecutionConfig

    Namespace

    Google \ Cloud \ Dataproc \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ service_account
    string

    Optional. Service account that used to execute workload.

    ↳ network_uri
    string

    Optional. Network URI to connect workload to.

    ↳ subnetwork_uri
    string

    Optional. Subnetwork URI to connect workload to.

    ↳ network_tags
    array

    Optional. Tags used for network traffic control.

    ↳ kms_key
    string

    Optional. The Cloud KMS key to use for encryption.

    ↳ idle_ttl
    Google\Protobuf\Duration

    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.

    ↳ ttl
    Google\Protobuf\Duration

    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.

    ↳ staging_bucket
    string

    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.

    getServiceAccount

    Optional. Service account that used to execute workload.

    Returns
    Type
    Description
    string

    setServiceAccount

    Optional. Service account that used to execute workload.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNetworkUri

    Optional. Network URI to connect workload to.

    Returns
    Type
    Description
    string

    hasNetworkUri

    setNetworkUri

    Optional. Network URI to connect workload to.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSubnetworkUri

    Optional. Subnetwork URI to connect workload to.

    Returns
    Type
    Description
    string

    hasSubnetworkUri

    setSubnetworkUri

    Optional. Subnetwork URI to connect workload to.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNetworkTags

    Optional. Tags used for network traffic control.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setNetworkTags

    Optional. Tags used for network traffic control.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getKmsKey

    Optional. The Cloud KMS key to use for encryption.

    Returns
    Type
    Description
    string

    setKmsKey

    Optional. The Cloud KMS key to use for encryption.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    Google\Protobuf\Duration |null

    hasIdleTtl

    clearIdleTtl

    setIdleTtl

    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.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    Google\Protobuf\Duration |null

    hasTtl

    clearTtl

    setTtl

    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.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setStagingBucket

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNetwork

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: