Class CreateWorkforceRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWorkforceRequest.Builder,CreateWorkforceRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateWorkforceRequest extends SageMakerRequest implements ToCopyableBuilder<CreateWorkforceRequest.Builder,CreateWorkforceRequest>
  • Method Details

    • cognitoConfig

      public final CognitoConfig cognitoConfig()

      Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

      Do not use OidcConfig if you specify values for CognitoConfig.

      Returns:
      Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

      Do not use OidcConfig if you specify values for CognitoConfig.

    • oidcConfig

      public final OidcConfig oidcConfig()

      Use this parameter to configure a private workforce using your own OIDC Identity Provider.

      Do not use CognitoConfig if you specify values for OidcConfig.

      Returns:
      Use this parameter to configure a private workforce using your own OIDC Identity Provider.

      Do not use CognitoConfig if you specify values for OidcConfig.

    • sourceIpConfig

      public final SourceIpConfig sourceIpConfig()
      Returns the value of the SourceIpConfig property for this object.
      Returns:
      The value of the SourceIpConfig property for this object.
    • workforceName

      public final String workforceName()

      The name of the private workforce.

      Returns:
      The name of the private workforce.
    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.
    • tags

      public final List<Tag> tags()

      An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

      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 hasTags() method.

      Returns:
      An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
    • workforceVpcConfig

      public final WorkforceVpcConfigRequest workforceVpcConfig()

      Use this parameter to configure a workforce using VPC.

      Returns:
      Use this parameter to configure a workforce using VPC.
    • toBuilder

      public CreateWorkforceRequest.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<CreateWorkforceRequest.Builder,CreateWorkforceRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T
    • builder

      public static CreateWorkforceRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateWorkforceRequest.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.