Class Workteam

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.Workteam
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Workteam.Builder,Workteam>
@Generated("software.amazon.awssdk:codegen") public final class Workteam extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Workteam.Builder,Workteam>

Provides details about a labeling work team.

See Also:

  • Method Details

    • workteamName

      public final String workteamName()

      The name of the work team.

      Returns:
      The name of the work team.

    • hasMemberDefinitions

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

    • memberDefinitions

      public final List<MemberDefinition> memberDefinitions()

      A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

      Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

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

      Returns:
      A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

      Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

    • workteamArn

      public final String workteamArn()

      The Amazon Resource Name (ARN) that identifies the work team.

      Returns:
      The Amazon Resource Name (ARN) that identifies the work team.

    • workforceArn

      public final String workforceArn()

      The Amazon Resource Name (ARN) of the workforce.

      Returns:
      The Amazon Resource Name (ARN) of the workforce.

    • hasProductListingIds

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

    • productListingIds

      public final List<String> productListingIds()

      The Amazon Marketplace identifier for a vendor's work team.

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

      Returns:
      The Amazon Marketplace identifier for a vendor's work team.

    • description

      public final String description()

      A description of the work team.

      Returns:
      A description of the work team.

    • subDomain

      public final String subDomain()

      The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

      Returns:
      The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

    • createDate

      public final Instant createDate()

      The date and time that the work team was created (timestamp).

      Returns:
      The date and time that the work team was created (timestamp).

    • lastUpdatedDate

      public final Instant lastUpdatedDate()

      The date and time that the work team was last updated (timestamp).

      Returns:
      The date and time that the work team was last updated (timestamp).

    • notificationConfiguration

      public final NotificationConfiguration notificationConfiguration()

      Configures SNS notifications of available or expiring work items for work teams.

      Returns:
      Configures SNS notifications of available or expiring work items for work teams.

    • workerAccessConfiguration

      public final WorkerAccessConfiguration workerAccessConfiguration()

      Describes any access constraints that have been defined for Amazon S3 resources.

      Returns:
      Describes any access constraints that have been defined for Amazon S3 resources.

    • toBuilder

      public Workteam.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<Workteam.Builder,Workteam>
      Returns:
      a builder for type T

    • builder

      public static Workteam.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.