Package software.amazon.awssdk.services.sagemaker.model

Class CreateWorkforceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorkforceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateWorkforceRequest.Builder	builder()
CognitoConfig	cognitoConfig()	Use this parameter to configure an Amazon Cognito private workforce.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
OidcConfig	oidcConfig()	Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkforceRequest.Builder>	serializableBuilderClass()
SourceIpConfig	sourceIpConfig()	Returns the value of the SourceIpConfig property for this object.
List<Tag>	tags()	An array of key-value pairs that contain metadata to help you categorize and organize our workforce.
CreateWorkforceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workforceName()	The name of the private workforce.
WorkforceVpcConfigRequest	workforceVpcConfig()	Use this parameter to configure a workforce using VPC.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkforceRequest.Builder,CreateWorkforceRequest>

Specified by:

toBuilder in class SageMakerRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo