Workforce (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.Workforce

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Workforce
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Workforce()

Constructors
Constructor and Description
`Workforce()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Workforce`	`clone()`
`boolean`	`equals(Object obj)`
`CognitoConfig`	`getCognitoConfig()` The configuration of an Amazon Cognito workforce.
`Date`	`getCreateDate()` The date that the workforce is created.
`Date`	`getLastUpdatedDate()` 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`	`getOidcConfig()` The configuration of an OIDC Identity Provider (IdP) private workforce.
`SourceIpConfig`	`getSourceIpConfig()` A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.
`String`	`getSubDomain()` The subdomain for your OIDC Identity Provider.
`String`	`getWorkforceArn()` The Amazon Resource Name (ARN) of the private workforce.
`String`	`getWorkforceName()` The name of the private workforce.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCognitoConfig(CognitoConfig cognitoConfig)` The configuration of an Amazon Cognito workforce.
`void`	`setCreateDate(Date createDate)` The date that the workforce is created.
`void`	`setLastUpdatedDate(Date 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.
`void`	`setOidcConfig(OidcConfigForResponse oidcConfig)` The configuration of an OIDC Identity Provider (IdP) private workforce.
`void`	`setSourceIpConfig(SourceIpConfig sourceIpConfig)` A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.
`void`	`setSubDomain(String subDomain)` The subdomain for your OIDC Identity Provider.
`void`	`setWorkforceArn(String workforceArn)` The Amazon Resource Name (ARN) of the private workforce.
`void`	`setWorkforceName(String workforceName)` The name of the private workforce.
`String`	`toString()` Returns a string representation of this object.
`Workforce`	`withCognitoConfig(CognitoConfig cognitoConfig)` The configuration of an Amazon Cognito workforce.
`Workforce`	`withCreateDate(Date createDate)` The date that the workforce is created.
`Workforce`	`withLastUpdatedDate(Date 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.
`Workforce`	`withOidcConfig(OidcConfigForResponse oidcConfig)` The configuration of an OIDC Identity Provider (IdP) private workforce.
`Workforce`	`withSourceIpConfig(SourceIpConfig sourceIpConfig)` A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.
`Workforce`	`withSubDomain(String subDomain)` The subdomain for your OIDC Identity Provider.
`Workforce`	`withWorkforceArn(String workforceArn)` The Amazon Resource Name (ARN) of the private workforce.
`Workforce`	`withWorkforceName(String workforceName)` The name of the private workforce.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Workforce
```
public Workforce()
```
- Method Detail
  - setWorkforceName
```
public void setWorkforceName(String workforceName)
```
    The name of the private workforce.
    
    Parameters:
    
    workforceName - The name of the private workforce.
  - getWorkforceName
```
public String getWorkforceName()
```
    The name of the private workforce.
    
    Returns:
    
    The name of the private workforce.
  - withWorkforceName
```
public Workforce withWorkforceName(String workforceName)
```
    The name of the private workforce.
    
    Parameters:
    
    workforceName - The name of the private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkforceArn
```
public void setWorkforceArn(String workforceArn)
```
    The Amazon Resource Name (ARN) of the private workforce.
    
    Parameters:
    
    workforceArn - The Amazon Resource Name (ARN) of the private workforce.
  - getWorkforceArn
```
public String getWorkforceArn()
```
    The Amazon Resource Name (ARN) of the private workforce.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the private workforce.
  - withWorkforceArn
```
public Workforce withWorkforceArn(String workforceArn)
```
    The Amazon Resource Name (ARN) of the private workforce.
    
    Parameters:
    
    workforceArn - The Amazon Resource Name (ARN) of the private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDate
```
public void setLastUpdatedDate(Date 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.
    
    Parameters:
    
    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.
  - getLastUpdatedDate
```
public Date getLastUpdatedDate()
```
    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.
  - withLastUpdatedDate
```
public Workforce withLastUpdatedDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceIpConfig
```
public void setSourceIpConfig(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.
    
    Parameters:
    
    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.
  - getSourceIpConfig
```
public SourceIpConfig getSourceIpConfig()
```
    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.
  - withSourceIpConfig
```
public Workforce withSourceIpConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubDomain
```
public void setSubDomain(String subDomain)
```
    The subdomain for your OIDC Identity Provider.
    
    Parameters:
    
    subDomain - The subdomain for your OIDC Identity Provider.
  - getSubDomain
```
public String getSubDomain()
```
    The subdomain for your OIDC Identity Provider.
    
    Returns:
    
    The subdomain for your OIDC Identity Provider.
  - withSubDomain
```
public Workforce withSubDomain(String subDomain)
```
    The subdomain for your OIDC Identity Provider.
    
    Parameters:
    
    subDomain - The subdomain for your OIDC Identity Provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCognitoConfig
```
public void setCognitoConfig(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.
    
    Parameters:
    
    cognitoConfig - The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
  - getCognitoConfig
```
public CognitoConfig getCognitoConfig()
```
    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.
  - withCognitoConfig
```
public Workforce withCognitoConfig(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOidcConfig
```
public void setOidcConfig(OidcConfigForResponse oidcConfig)
```
    The configuration of an OIDC Identity Provider (IdP) private workforce.
    
    Parameters:
    
    oidcConfig - The configuration of an OIDC Identity Provider (IdP) private workforce.
  - getOidcConfig
```
public OidcConfigForResponse getOidcConfig()
```
    The configuration of an OIDC Identity Provider (IdP) private workforce.
    
    Returns:
    
    The configuration of an OIDC Identity Provider (IdP) private workforce.
  - withOidcConfig
```
public Workforce withOidcConfig(OidcConfigForResponse oidcConfig)
```
    The configuration of an OIDC Identity Provider (IdP) private workforce.
    
    Parameters:
    
    oidcConfig - The configuration of an OIDC Identity Provider (IdP) private workforce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateDate
```
public void setCreateDate(Date createDate)
```
    The date that the workforce is created.
    
    Parameters:
    
    createDate - The date that the workforce is created.
  - getCreateDate
```
public Date getCreateDate()
```
    The date that the workforce is created.
    
    Returns:
    
    The date that the workforce is created.
  - withCreateDate
```
public Workforce withCreateDate(Date createDate)
```
    The date that the workforce is created.
    
    Parameters:
    
    createDate - The date that the workforce is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Workforce clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Workforce

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workforce

Method Detail

setWorkforceName

getWorkforceName

withWorkforceName

setWorkforceArn

getWorkforceArn

withWorkforceArn

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

setSourceIpConfig

getSourceIpConfig

withSourceIpConfig

setSubDomain

getSubDomain

withSubDomain

setCognitoConfig

getCognitoConfig

withCognitoConfig

setOidcConfig

getOidcConfig

withOidcConfig

setCreateDate

getCreateDate

withCreateDate

toString

equals

hashCode

clone

marshall