software.amazon.awssdk.services.sagemaker.model

Class Workteam

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Workteam

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Workteam.Builder,Workteam>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Workteam.Builder

Method Summary

Modifier and Type	Method and Description
static Workteam.Builder	builder()
Instant	createDate() The date and time that the work team was created (timestamp).
String	description() A description of the work team.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMemberDefinitions() For responses, this returns true if the service returned a value for the MemberDefinitions property.
boolean	hasProductListingIds() For responses, this returns true if the service returned a value for the ProductListingIds property.
Instant	lastUpdatedDate() The date and time that the work team was last updated (timestamp).
List<MemberDefinition>	memberDefinitions() A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
NotificationConfiguration	notificationConfiguration() Configures SNS notifications of available or expiring work items for work teams.
List<String>	productListingIds() The Amazon Marketplace identifier for a vendor's work team.
List<SdkField<?>>	sdkFields()
static Class<? extends Workteam.Builder>	serializableBuilderClass()
String	subDomain() The URI of the labeling job's user interface.
Workteam.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workforceArn() The Amazon Resource Name (ARN) of the workforce.
String	workteamArn() The Amazon Resource Name (ARN) that identifies the work team.
String	workteamName() The name of the work team.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

toBuilder

public Workteam.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Workteam.Builder,Workteam>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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