Interface Session.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Session.Builder,Session>, SdkBuilder<Session.Builder,Session>, SdkPojo
Enclosing class:
Session
@Mutable @NotThreadSafe public static interface Session.Builder extends SdkPojo, CopyableBuilder<Session.Builder,Session>

  • Method Details

    • id

      Session.Builder id(String id)

      The ID of the session.

      Parameters:
      id - The ID of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterId

      Session.Builder clusterId(String clusterId)

      The ID of the cluster that the session belongs to.

      Parameters:
      clusterId - The ID of the cluster that the session belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Session.Builder name(String name)

      The name of the session, if one was provided at creation time.

      Parameters:
      name - The name of the session, if one was provided at creation time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Session.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the session.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Session.Builder state(String state)

      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED , and FAILED.

      Parameters:
      state - The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Session.Builder state(SessionState state)

      The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED , and FAILED.

      Parameters:
      state - The current state of the session. Valid values are SUBMITTED, STARTING, STARTED, IDLE, BUSY, TERMINATING, TERMINATED, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateChangeReason

      Session.Builder stateChangeReason(String stateChangeReason)

      A human-readable message describing the most recent state change.

      Parameters:
      stateChangeReason - A human-readable message describing the most recent state change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseLabel

      Session.Builder releaseLabel(String releaseLabel)

      The Amazon EMR release label of the cluster that the session is running on.

      Parameters:
      releaseLabel - The Amazon EMR release label of the cluster that the session is running on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionRoleArn

      Session.Builder executionRoleArn(String executionRoleArn)

      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

      Parameters:
      executionRoleArn - The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountId

      Session.Builder accountId(String accountId)

      The Amazon Web Services account ID that owns the session.

      Parameters:
      accountId - The Amazon Web Services account ID that owns the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Session.Builder createdAt(Instant createdAt)

      The date and time that the session was created.

      Parameters:
      createdAt - The date and time that the session was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Session.Builder updatedAt(Instant updatedAt)

      The date and time that the session was last updated.

      Parameters:
      updatedAt - The date and time that the session was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      Session.Builder startedAt(Instant startedAt)

      The date and time that the session entered the STARTED state.

      Parameters:
      startedAt - The date and time that the session entered the STARTED state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endedAt

      Session.Builder endedAt(Instant endedAt)

      The date and time that the session was terminated or failed.

      Parameters:
      endedAt - The date and time that the session was terminated or failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idleSince

      Session.Builder idleSince(Instant idleSince)

      The date and time that the session last entered the IDLE state.

      Parameters:
      idleSince - The date and time that the session last entered the IDLE state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      Session.Builder engineConfigurations(Collection<Configuration> engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      Parameters:
      engineConfigurations - The configuration overrides for the session. Only runtime configuration overrides are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      Session.Builder engineConfigurations(Configuration... engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      Parameters:
      engineConfigurations - The configuration overrides for the session. Only runtime configuration overrides are supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineConfigurations

      Session.Builder engineConfigurations(Consumer<Configuration.Builder>... engineConfigurations)

      The configuration overrides for the session. Only runtime configuration overrides are supported.

      This is a convenience method that creates an instance of the Configuration.Builder avoiding the need to create one manually via Configuration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to engineConfigurations(List<Configuration>).

      Parameters:
      engineConfigurations - a consumer that will call methods on Configuration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • monitoringConfiguration

      Session.Builder monitoringConfiguration(SessionMonitoringConfiguration monitoringConfiguration)

      The monitoring configuration for the session.

      Parameters:
      monitoringConfiguration - The monitoring configuration for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monitoringConfiguration

      default Session.Builder monitoringConfiguration(Consumer<SessionMonitoringConfiguration.Builder> monitoringConfiguration)

      The monitoring configuration for the session.

      This is a convenience method that creates an instance of the SessionMonitoringConfiguration.Builder avoiding the need to create one manually via SessionMonitoringConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to monitoringConfiguration(SessionMonitoringConfiguration).

      Parameters:
      monitoringConfiguration - a consumer that will call methods on SessionMonitoringConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sessionIdleTimeoutInMinutes

      Session.Builder sessionIdleTimeoutInMinutes(Long sessionIdleTimeoutInMinutes)

      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.

      Parameters:
      sessionIdleTimeoutInMinutes - The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateAuthority

      Session.Builder certificateAuthority(CertificateAuthority certificateAuthority)

      The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.

      Parameters:
      certificateAuthority - The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateAuthority

      default Session.Builder certificateAuthority(Consumer<CertificateAuthority.Builder> certificateAuthority)

      The certificate authority used to establish an mTLS connection to the Spark Connect server when connecting directly over VPC peering.

      This is a convenience method that creates an instance of the CertificateAuthority.Builder avoiding the need to create one manually via CertificateAuthority.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateAuthority(CertificateAuthority).

      Parameters:
      certificateAuthority - a consumer that will call methods on CertificateAuthority.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverUrl

      Session.Builder serverUrl(String serverUrl)

      The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.

      Parameters:
      serverUrl - The Spark Connect server URL for the session. Use this URL with the Credentials returned by GetSessionEndpoint to connect directly to the session over VPC peering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Session.Builder tags(Collection<Tag> tags)

      The tags associated with the session.

      Parameters:
      tags - The tags associated with the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Session.Builder tags(Tag... tags)

      The tags associated with the session.

      Parameters:
      tags - The tags associated with the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Session.Builder tags(Consumer<Tag.Builder>... tags)

      The tags associated with the session.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: