@Generated(value="software.amazon.awssdk:codegen") public final class UpdateWorkteamRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateWorkteamRequest.Builder,UpdateWorkteamRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateWorkteamRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static UpdateWorkteamRequest.Builder |
builder() |
String |
description()
An updated description for 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.
|
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 topic notifications for available or expiring work items
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateWorkteamRequest.Builder> |
serializableBuilderClass() |
UpdateWorkteamRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
workteamName()
The name of the work team to update.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String workteamName()
The name of the work team to update.
public final boolean hasMemberDefinitions()
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.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. You should not provide input for both of these
parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups
within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that
make up the member definition must have the same ClientId and UserPool values. To add a
Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more
information about user pools, see Amazon Cognito
User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private
work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user
groups that are already in the work team must also be listed in Groups when you make this request to
remain on the work team. If you do not include these user groups, they will no longer be associated with the work
team you update.
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.
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. You should not provide
input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user
groups within the user pool used to create a workforce. All of the
CognitoMemberDefinition objects that make up the member definition must have the same
ClientId and UserPool values. To add a Amazon Cognito user group to an existing
worker pool, see Adding groups to a User Pool. For more information about user pools, see
Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your
private work team in OidcMemberDefinition by listing those groups in Groups. Be
aware that user groups that are already in the work team must also be listed in Groups when
you make this request to remain on the work team. If you do not include these user groups, they will no
longer be associated with the work team you update.
public final String description()
An updated description for the work team.
public final NotificationConfiguration notificationConfiguration()
Configures SNS topic notifications for available or expiring work items
public UpdateWorkteamRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateWorkteamRequest.Builder,UpdateWorkteamRequest>toBuilder in class SageMakerRequestpublic static UpdateWorkteamRequest.Builder builder()
public static Class<? extends UpdateWorkteamRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.