software.amazon.awssdk.services.sagemaker.model

Class Workforce

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Workforce

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class Workforce
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Workforce.Builder,Workforce>

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Workforce.Builder

Method Summary

Modifier and Type	Method and Description
static Workforce.Builder	builder()
CognitoConfig	cognitoConfig() The configuration of an Amazon Cognito workforce.
Instant	createDate() The date that the workforce is created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDate() The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
OidcConfigForResponse	oidcConfig() The configuration of an OIDC Identity Provider (IdP) private workforce.
List<SdkField<?>>	sdkFields()
static Class<? extends Workforce.Builder>	serializableBuilderClass()
SourceIpConfig	sourceIpConfig() A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.
String	subDomain() The subdomain for your OIDC Identity Provider.
Workforce.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	workforceArn() The Amazon Resource Name (ARN) of the private workforce.
String	workforceName() The name of the private workforce.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

workforceName

public final String workforceName()

The name of the private workforce.

Returns:

The name of the private workforce.

workforceArn

public final String workforceArn()

The Amazon Resource Name (ARN) of the private workforce.

Returns:

The Amazon Resource Name (ARN) of the private workforce.

lastUpdatedDate

public final Instant lastUpdatedDate()

The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

Returns:

The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

sourceIpConfig

public final SourceIpConfig sourceIpConfig()

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

Returns:

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

subDomain

public final String subDomain()

The subdomain for your OIDC Identity Provider.

Returns:

The subdomain for your OIDC Identity Provider.

cognitoConfig

public final CognitoConfig cognitoConfig()

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Returns:

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

oidcConfig

public final OidcConfigForResponse oidcConfig()

The configuration of an OIDC Identity Provider (IdP) private workforce.

Returns:

The configuration of an OIDC Identity Provider (IdP) private workforce.

createDate

public final Instant createDate()

The date that the workforce is created.

Returns:

The date that the workforce is created.

toBuilder

public Workforce.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<Workforce.Builder,Workforce>

Returns:

a builder for type T

builder

public static Workforce.Builder builder()

serializableBuilderClass

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