1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataproc
  5. dataproc/v1
  6. getSession

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.dataproc/v1.getSession

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Gets the resource representation for an interactive session.

    Using getSession

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSession(args: GetSessionArgs, opts?: InvokeOptions): Promise<GetSessionResult>
    function getSessionOutput(args: GetSessionOutputArgs, opts?: InvokeOptions): Output<GetSessionResult>
    def get_session(location: Optional[str] = None,
                    project: Optional[str] = None,
                    session_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSessionResult
    def get_session_output(location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    session_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetSessionResult]
    func LookupSession(ctx *Context, args *LookupSessionArgs, opts ...InvokeOption) (*LookupSessionResult, error)
    func LookupSessionOutput(ctx *Context, args *LookupSessionOutputArgs, opts ...InvokeOption) LookupSessionResultOutput

    > Note: This function is named LookupSession in the Go SDK.

    public static class GetSession 
    {
        public static Task<GetSessionResult> InvokeAsync(GetSessionArgs args, InvokeOptions? opts = null)
        public static Output<GetSessionResult> Invoke(GetSessionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSessionResult> getSession(GetSessionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:dataproc/v1:getSession
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Location string
    SessionId string
    Project string
    Location string
    SessionId string
    Project string
    location String
    sessionId String
    project String
    location string
    sessionId string
    project string
    location String
    sessionId String
    project String

    getSession Result

    The following output properties are available:

    CreateTime string
    The time when the session was created.
    Creator string
    The email address of the user who created the session.
    EnvironmentConfig Pulumi.GoogleNative.Dataproc.V1.Outputs.EnvironmentConfigResponse
    Optional. Environment configuration for the session execution.
    JupyterSession Pulumi.GoogleNative.Dataproc.V1.Outputs.JupyterConfigResponse
    Optional. Jupyter session config.
    Labels Dictionary<string, string>
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    Name string
    The resource name of the session.
    RuntimeConfig Pulumi.GoogleNative.Dataproc.V1.Outputs.RuntimeConfigResponse
    Optional. Runtime configuration for the session execution.
    RuntimeInfo Pulumi.GoogleNative.Dataproc.V1.Outputs.RuntimeInfoResponse
    Runtime information about session execution.
    SessionTemplate string
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    State string
    A state of the session.
    StateHistory List<Pulumi.GoogleNative.Dataproc.V1.Outputs.SessionStateHistoryResponse>
    Historical state information for the session.
    StateMessage string
    Session state details, such as the failure description if the state is FAILED.
    StateTime string
    The time when the session entered the current state.
    User string
    Optional. The email address of the user who owns the session.
    Uuid string
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    CreateTime string
    The time when the session was created.
    Creator string
    The email address of the user who created the session.
    EnvironmentConfig EnvironmentConfigResponse
    Optional. Environment configuration for the session execution.
    JupyterSession JupyterConfigResponse
    Optional. Jupyter session config.
    Labels map[string]string
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    Name string
    The resource name of the session.
    RuntimeConfig RuntimeConfigResponse
    Optional. Runtime configuration for the session execution.
    RuntimeInfo RuntimeInfoResponse
    Runtime information about session execution.
    SessionTemplate string
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    State string
    A state of the session.
    StateHistory []SessionStateHistoryResponse
    Historical state information for the session.
    StateMessage string
    Session state details, such as the failure description if the state is FAILED.
    StateTime string
    The time when the session entered the current state.
    User string
    Optional. The email address of the user who owns the session.
    Uuid string
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    createTime String
    The time when the session was created.
    creator String
    The email address of the user who created the session.
    environmentConfig EnvironmentConfigResponse
    Optional. Environment configuration for the session execution.
    jupyterSession JupyterConfigResponse
    Optional. Jupyter session config.
    labels Map<String,String>
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    name String
    The resource name of the session.
    runtimeConfig RuntimeConfigResponse
    Optional. Runtime configuration for the session execution.
    runtimeInfo RuntimeInfoResponse
    Runtime information about session execution.
    sessionTemplate String
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    state String
    A state of the session.
    stateHistory List<SessionStateHistoryResponse>
    Historical state information for the session.
    stateMessage String
    Session state details, such as the failure description if the state is FAILED.
    stateTime String
    The time when the session entered the current state.
    user String
    Optional. The email address of the user who owns the session.
    uuid String
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    createTime string
    The time when the session was created.
    creator string
    The email address of the user who created the session.
    environmentConfig EnvironmentConfigResponse
    Optional. Environment configuration for the session execution.
    jupyterSession JupyterConfigResponse
    Optional. Jupyter session config.
    labels {[key: string]: string}
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    name string
    The resource name of the session.
    runtimeConfig RuntimeConfigResponse
    Optional. Runtime configuration for the session execution.
    runtimeInfo RuntimeInfoResponse
    Runtime information about session execution.
    sessionTemplate string
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    state string
    A state of the session.
    stateHistory SessionStateHistoryResponse[]
    Historical state information for the session.
    stateMessage string
    Session state details, such as the failure description if the state is FAILED.
    stateTime string
    The time when the session entered the current state.
    user string
    Optional. The email address of the user who owns the session.
    uuid string
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    create_time str
    The time when the session was created.
    creator str
    The email address of the user who created the session.
    environment_config EnvironmentConfigResponse
    Optional. Environment configuration for the session execution.
    jupyter_session JupyterConfigResponse
    Optional. Jupyter session config.
    labels Mapping[str, str]
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    name str
    The resource name of the session.
    runtime_config RuntimeConfigResponse
    Optional. Runtime configuration for the session execution.
    runtime_info RuntimeInfoResponse
    Runtime information about session execution.
    session_template str
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    state str
    A state of the session.
    state_history Sequence[SessionStateHistoryResponse]
    Historical state information for the session.
    state_message str
    Session state details, such as the failure description if the state is FAILED.
    state_time str
    The time when the session entered the current state.
    user str
    Optional. The email address of the user who owns the session.
    uuid str
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
    createTime String
    The time when the session was created.
    creator String
    The email address of the user who created the session.
    environmentConfig Property Map
    Optional. Environment configuration for the session execution.
    jupyterSession Property Map
    Optional. Jupyter session config.
    labels Map<String>
    Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
    name String
    The resource name of the session.
    runtimeConfig Property Map
    Optional. Runtime configuration for the session execution.
    runtimeInfo Property Map
    Runtime information about session execution.
    sessionTemplate String
    Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
    state String
    A state of the session.
    stateHistory List<Property Map>
    Historical state information for the session.
    stateMessage String
    Session state details, such as the failure description if the state is FAILED.
    stateTime String
    The time when the session entered the current state.
    user String
    Optional. The email address of the user who owns the session.
    uuid String
    A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.

    Supporting Types

    EnvironmentConfigResponse

    ExecutionConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.ExecutionConfigResponse
    Optional. Execution configuration for a workload.
    PeripheralsConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.PeripheralsConfigResponse
    Optional. Peripherals configuration that workload has access to.
    ExecutionConfig ExecutionConfigResponse
    Optional. Execution configuration for a workload.
    PeripheralsConfig PeripheralsConfigResponse
    Optional. Peripherals configuration that workload has access to.
    executionConfig ExecutionConfigResponse
    Optional. Execution configuration for a workload.
    peripheralsConfig PeripheralsConfigResponse
    Optional. Peripherals configuration that workload has access to.
    executionConfig ExecutionConfigResponse
    Optional. Execution configuration for a workload.
    peripheralsConfig PeripheralsConfigResponse
    Optional. Peripherals configuration that workload has access to.
    execution_config ExecutionConfigResponse
    Optional. Execution configuration for a workload.
    peripherals_config PeripheralsConfigResponse
    Optional. Peripherals configuration that workload has access to.
    executionConfig Property Map
    Optional. Execution configuration for a workload.
    peripheralsConfig Property Map
    Optional. Peripherals configuration that workload has access to.

    ExecutionConfigResponse

    IdleTtl string
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    KmsKey string
    Optional. The Cloud KMS key to use for encryption.
    NetworkTags List<string>
    Optional. Tags used for network traffic control.
    NetworkUri string
    Optional. Network URI to connect workload to.
    ServiceAccount string
    Optional. Service account that used to execute workload.
    StagingBucket 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.
    SubnetworkUri string
    Optional. Subnetwork URI to connect workload to.
    Ttl string
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.
    IdleTtl string
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    KmsKey string
    Optional. The Cloud KMS key to use for encryption.
    NetworkTags []string
    Optional. Tags used for network traffic control.
    NetworkUri string
    Optional. Network URI to connect workload to.
    ServiceAccount string
    Optional. Service account that used to execute workload.
    StagingBucket 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.
    SubnetworkUri string
    Optional. Subnetwork URI to connect workload to.
    Ttl string
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.
    idleTtl String
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    kmsKey String
    Optional. The Cloud KMS key to use for encryption.
    networkTags List<String>
    Optional. Tags used for network traffic control.
    networkUri String
    Optional. Network URI to connect workload to.
    serviceAccount String
    Optional. Service account that used to execute workload.
    stagingBucket 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.
    subnetworkUri String
    Optional. Subnetwork URI to connect workload to.
    ttl String
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.
    idleTtl string
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    kmsKey string
    Optional. The Cloud KMS key to use for encryption.
    networkTags string[]
    Optional. Tags used for network traffic control.
    networkUri string
    Optional. Network URI to connect workload to.
    serviceAccount string
    Optional. Service account that used to execute workload.
    stagingBucket 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.
    subnetworkUri string
    Optional. Subnetwork URI to connect workload to.
    ttl string
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.
    idle_ttl str
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    kms_key str
    Optional. The Cloud KMS key to use for encryption.
    network_tags Sequence[str]
    Optional. Tags used for network traffic control.
    network_uri str
    Optional. Network URI to connect workload to.
    service_account str
    Optional. Service account that used to execute workload.
    staging_bucket str
    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.
    subnetwork_uri str
    Optional. Subnetwork URI to connect workload to.
    ttl str
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.
    idleTtl String
    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 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 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.
    kmsKey String
    Optional. The Cloud KMS key to use for encryption.
    networkTags List<String>
    Optional. Tags used for network traffic control.
    networkUri String
    Optional. Network URI to connect workload to.
    serviceAccount String
    Optional. Service account that used to execute workload.
    stagingBucket 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.
    subnetworkUri String
    Optional. Subnetwork URI to connect workload to.
    ttl String
    Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). 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.

    JupyterConfigResponse

    DisplayName string
    Optional. Display name, shown in the Jupyter kernelspec card.
    Kernel string
    Optional. Kernel
    DisplayName string
    Optional. Display name, shown in the Jupyter kernelspec card.
    Kernel string
    Optional. Kernel
    displayName String
    Optional. Display name, shown in the Jupyter kernelspec card.
    kernel String
    Optional. Kernel
    displayName string
    Optional. Display name, shown in the Jupyter kernelspec card.
    kernel string
    Optional. Kernel
    display_name str
    Optional. Display name, shown in the Jupyter kernelspec card.
    kernel str
    Optional. Kernel
    displayName String
    Optional. Display name, shown in the Jupyter kernelspec card.
    kernel String
    Optional. Kernel

    PeripheralsConfigResponse

    MetastoreService string
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    SparkHistoryServerConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.SparkHistoryServerConfigResponse
    Optional. The Spark History Server configuration for the workload.
    MetastoreService string
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    SparkHistoryServerConfig SparkHistoryServerConfigResponse
    Optional. The Spark History Server configuration for the workload.
    metastoreService String
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    sparkHistoryServerConfig SparkHistoryServerConfigResponse
    Optional. The Spark History Server configuration for the workload.
    metastoreService string
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    sparkHistoryServerConfig SparkHistoryServerConfigResponse
    Optional. The Spark History Server configuration for the workload.
    metastore_service str
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    spark_history_server_config SparkHistoryServerConfigResponse
    Optional. The Spark History Server configuration for the workload.
    metastoreService String
    Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
    sparkHistoryServerConfig Property Map
    Optional. The Spark History Server configuration for the workload.

    PyPiRepositoryConfigResponse

    PypiRepository string
    Optional. PyPi repository address
    PypiRepository string
    Optional. PyPi repository address
    pypiRepository String
    Optional. PyPi repository address
    pypiRepository string
    Optional. PyPi repository address
    pypi_repository str
    Optional. PyPi repository address
    pypiRepository String
    Optional. PyPi repository address

    RepositoryConfigResponse

    PypiRepositoryConfig PyPiRepositoryConfigResponse
    Optional. Configuration for PyPi repository.
    pypiRepositoryConfig PyPiRepositoryConfigResponse
    Optional. Configuration for PyPi repository.
    pypiRepositoryConfig PyPiRepositoryConfigResponse
    Optional. Configuration for PyPi repository.
    pypi_repository_config PyPiRepositoryConfigResponse
    Optional. Configuration for PyPi repository.
    pypiRepositoryConfig Property Map
    Optional. Configuration for PyPi repository.

    RuntimeConfigResponse

    ContainerImage string
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    Properties Dictionary<string, string>
    Optional. A mapping of property names to values, which are used to configure workload execution.
    RepositoryConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.RepositoryConfigResponse
    Optional. Dependency repository configuration.
    Version string
    Optional. Version of the batch runtime.
    ContainerImage string
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    Properties map[string]string
    Optional. A mapping of property names to values, which are used to configure workload execution.
    RepositoryConfig RepositoryConfigResponse
    Optional. Dependency repository configuration.
    Version string
    Optional. Version of the batch runtime.
    containerImage String
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    properties Map<String,String>
    Optional. A mapping of property names to values, which are used to configure workload execution.
    repositoryConfig RepositoryConfigResponse
    Optional. Dependency repository configuration.
    version String
    Optional. Version of the batch runtime.
    containerImage string
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    properties {[key: string]: string}
    Optional. A mapping of property names to values, which are used to configure workload execution.
    repositoryConfig RepositoryConfigResponse
    Optional. Dependency repository configuration.
    version string
    Optional. Version of the batch runtime.
    container_image str
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    properties Mapping[str, str]
    Optional. A mapping of property names to values, which are used to configure workload execution.
    repository_config RepositoryConfigResponse
    Optional. Dependency repository configuration.
    version str
    Optional. Version of the batch runtime.
    containerImage String
    Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
    properties Map<String>
    Optional. A mapping of property names to values, which are used to configure workload execution.
    repositoryConfig Property Map
    Optional. Dependency repository configuration.
    version String
    Optional. Version of the batch runtime.

    RuntimeInfoResponse

    ApproximateUsage Pulumi.GoogleNative.Dataproc.V1.Inputs.UsageMetricsResponse
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    CurrentUsage Pulumi.GoogleNative.Dataproc.V1.Inputs.UsageSnapshotResponse
    Snapshot of current workload resource usage.
    DiagnosticOutputUri string
    A URI pointing to the location of the diagnostics tarball.
    Endpoints Dictionary<string, string>
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    OutputUri string
    A URI pointing to the location of the stdout and stderr of the workload.
    ApproximateUsage UsageMetricsResponse
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    CurrentUsage UsageSnapshotResponse
    Snapshot of current workload resource usage.
    DiagnosticOutputUri string
    A URI pointing to the location of the diagnostics tarball.
    Endpoints map[string]string
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    OutputUri string
    A URI pointing to the location of the stdout and stderr of the workload.
    approximateUsage UsageMetricsResponse
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    currentUsage UsageSnapshotResponse
    Snapshot of current workload resource usage.
    diagnosticOutputUri String
    A URI pointing to the location of the diagnostics tarball.
    endpoints Map<String,String>
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    outputUri String
    A URI pointing to the location of the stdout and stderr of the workload.
    approximateUsage UsageMetricsResponse
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    currentUsage UsageSnapshotResponse
    Snapshot of current workload resource usage.
    diagnosticOutputUri string
    A URI pointing to the location of the diagnostics tarball.
    endpoints {[key: string]: string}
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    outputUri string
    A URI pointing to the location of the stdout and stderr of the workload.
    approximate_usage UsageMetricsResponse
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    current_usage UsageSnapshotResponse
    Snapshot of current workload resource usage.
    diagnostic_output_uri str
    A URI pointing to the location of the diagnostics tarball.
    endpoints Mapping[str, str]
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    output_uri str
    A URI pointing to the location of the stdout and stderr of the workload.
    approximateUsage Property Map
    Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).
    currentUsage Property Map
    Snapshot of current workload resource usage.
    diagnosticOutputUri String
    A URI pointing to the location of the diagnostics tarball.
    endpoints Map<String>
    Map of remote access endpoints (such as web interfaces and APIs) to their URIs.
    outputUri String
    A URI pointing to the location of the stdout and stderr of the workload.

    SessionStateHistoryResponse

    State string
    The state of the session at this point in the session history.
    StateMessage string
    Details about the state at this point in the session history.
    StateStartTime string
    The time when the session entered the historical state.
    State string
    The state of the session at this point in the session history.
    StateMessage string
    Details about the state at this point in the session history.
    StateStartTime string
    The time when the session entered the historical state.
    state String
    The state of the session at this point in the session history.
    stateMessage String
    Details about the state at this point in the session history.
    stateStartTime String
    The time when the session entered the historical state.
    state string
    The state of the session at this point in the session history.
    stateMessage string
    Details about the state at this point in the session history.
    stateStartTime string
    The time when the session entered the historical state.
    state str
    The state of the session at this point in the session history.
    state_message str
    Details about the state at this point in the session history.
    state_start_time str
    The time when the session entered the historical state.
    state String
    The state of the session at this point in the session history.
    stateMessage String
    Details about the state at this point in the session history.
    stateStartTime String
    The time when the session entered the historical state.

    SparkHistoryServerConfigResponse

    DataprocCluster string
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
    DataprocCluster string
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
    dataprocCluster String
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
    dataprocCluster string
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
    dataproc_cluster str
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
    dataprocCluster String
    Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]

    UsageMetricsResponse

    AcceleratorType string
    Optional. Accelerator type being used, if any
    MilliAcceleratorSeconds string
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    MilliDcuSeconds string
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    ShuffleStorageGbSeconds string
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    AcceleratorType string
    Optional. Accelerator type being used, if any
    MilliAcceleratorSeconds string
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    MilliDcuSeconds string
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    ShuffleStorageGbSeconds string
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    acceleratorType String
    Optional. Accelerator type being used, if any
    milliAcceleratorSeconds String
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuSeconds String
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGbSeconds String
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    acceleratorType string
    Optional. Accelerator type being used, if any
    milliAcceleratorSeconds string
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuSeconds string
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGbSeconds string
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    accelerator_type str
    Optional. Accelerator type being used, if any
    milli_accelerator_seconds str
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milli_dcu_seconds str
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffle_storage_gb_seconds str
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    acceleratorType String
    Optional. Accelerator type being used, if any
    milliAcceleratorSeconds String
    Optional. Accelerator usage in (milliAccelerator x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuSeconds String
    Optional. DCU (Dataproc Compute Units) usage in (milliDCU x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGbSeconds String
    Optional. Shuffle storage usage in (GB x seconds) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).

    UsageSnapshotResponse

    AcceleratorType string
    Optional. Accelerator type being used, if any
    MilliAccelerator string
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    MilliDcu string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    MilliDcuPremium string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    ShuffleStorageGb string
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    ShuffleStorageGbPremium string
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    SnapshotTime string
    Optional. The timestamp of the usage snapshot.
    AcceleratorType string
    Optional. Accelerator type being used, if any
    MilliAccelerator string
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    MilliDcu string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    MilliDcuPremium string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    ShuffleStorageGb string
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    ShuffleStorageGbPremium string
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    SnapshotTime string
    Optional. The timestamp of the usage snapshot.
    acceleratorType String
    Optional. Accelerator type being used, if any
    milliAccelerator String
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    milliDcu String
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuPremium String
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGb String
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    shuffleStorageGbPremium String
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    snapshotTime String
    Optional. The timestamp of the usage snapshot.
    acceleratorType string
    Optional. Accelerator type being used, if any
    milliAccelerator string
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    milliDcu string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuPremium string
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGb string
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    shuffleStorageGbPremium string
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    snapshotTime string
    Optional. The timestamp of the usage snapshot.
    accelerator_type str
    Optional. Accelerator type being used, if any
    milli_accelerator str
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    milli_dcu str
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milli_dcu_premium str
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffle_storage_gb str
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    shuffle_storage_gb_premium str
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    snapshot_time str
    Optional. The timestamp of the usage snapshot.
    acceleratorType String
    Optional. Accelerator type being used, if any
    milliAccelerator String
    Optional. Milli (one-thousandth) accelerator. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    milliDcu String
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    milliDcuPremium String
    Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at premium tier (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).
    shuffleStorageGb String
    Optional. Shuffle Storage in gigabytes (GB). (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    shuffleStorageGbPremium String
    Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing))
    snapshotTime String
    Optional. The timestamp of the usage snapshot.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi