Class StartNotebookRunRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datazone.model.DataZoneRequest
software.amazon.awssdk.services.datazone.model.StartNotebookRunRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartNotebookRunRequest extends DataZoneRequest implements ToCopyableBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>

  • Method Details

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

      Returns:
      The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

    • owningProjectIdentifier

      public final String owningProjectIdentifier()

      The identifier of the project that owns the notebook run.

      Returns:
      The identifier of the project that owns the notebook run.

    • notebookIdentifier

      public final String notebookIdentifier()

      The identifier of the notebook to run.

      Returns:
      The identifier of the notebook to run.

    • scheduleIdentifier

      public final String scheduleIdentifier()

      The identifier of the schedule associated with the notebook run.

      Returns:
      The identifier of the schedule associated with the notebook run.

    • computeConfiguration

      public final ComputeConfig computeConfiguration()

      The compute configuration for the notebook run, including instance type and environment version.

      Returns:
      The compute configuration for the notebook run, including instance type and environment version.

    • networkConfiguration

      public final NetworkConfig networkConfiguration()

      The network configuration for the notebook run, including network access type and optional VPC settings.

      Returns:
      The network configuration for the notebook run, including network access type and optional VPC settings.

    • timeoutConfiguration

      public final TimeoutConfig timeoutConfiguration()

      The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

      Returns:
      The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

    • triggerSource

      public final TriggerSource triggerSource()

      The source that triggered the notebook run.

      Returns:
      The source that triggered the notebook run.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metadata

      public final Map<String,String> metadata()

      The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadata() method.

      Returns:
      The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final Map<String,String> parameters()

      The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

      Returns:
      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    • toBuilder

      public StartNotebookRunRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>
      Specified by:
      toBuilder in class DataZoneRequest
      Returns:
      a builder for type T

    • builder

      public static StartNotebookRunRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartNotebookRunRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.