Class CreateWorkforceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateWorkforceRequest.Builder,
CreateWorkforceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final CognitoConfig
Use this parameter to configure an Amazon Cognito private workforce.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final OidcConfig
Use this parameter to configure a private workforce using your own OIDC Identity Provider.static Class
<? extends CreateWorkforceRequest.Builder> final SourceIpConfig
Returns the value of the SourceIpConfig property for this object.tags()
An array of key-value pairs that contain metadata to help you categorize and organize our workforce.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name of the private workforce.Use this parameter to configure a workforce using VPC.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 forCognitoConfig
.- 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 forCognitoConfig
.
-
oidcConfig
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use
CognitoConfig
if you specify values forOidcConfig
.- Returns:
- Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use
CognitoConfig
if you specify values forOidcConfig
.
-
sourceIpConfig
Returns the value of the SourceIpConfig property for this object.- Returns:
- The value of the SourceIpConfig property for this object.
-
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 theisEmpty()
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
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
Use this parameter to configure a workforce using VPC.
- Returns:
- Use this parameter to configure a workforce using VPC.
-
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 interfaceToCopyableBuilder<CreateWorkforceRequest.Builder,
CreateWorkforceRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-