Workgroup (AWS Java SDK :: Services :: Redshift Serverless 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.redshiftserverless.model.Workgroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Workgroup.Builder,Workgroup>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Workgroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Workgroup.Builder,Workgroup>
```
The collection of computing resources from which an endpoint is created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Workgroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Workgroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`baseCapacity()` The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
`static Workgroup.Builder`	`builder()`
`List<ConfigParameter>`	`configParameters()` An array of parameters to set for advanced control over a database.
`Instant`	`creationDate()` The creation date of the workgroup.
`Endpoint`	`endpoint()` The endpoint that is created from the workgroup.
`Boolean`	`enhancedVpcRouting()` The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConfigParameters()` For responses, this returns true if the service returned a value for the ConfigParameters property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`String`	`namespaceName()` The namespace the workgroup is associated with.
`Integer`	`port()` The custom port to use when connecting to a workgroup.
`Boolean`	`publiclyAccessible()` A value that specifies whether the workgroup can be accessible from a public network
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` An array of security group IDs to associate with the workgroup.
`static Class<? extends Workgroup.Builder>`	`serializableBuilderClass()`
`WorkgroupStatus`	`status()` The status of the workgroup.
`String`	`statusAsString()` The status of the workgroup.
`List<String>`	`subnetIds()` An array of subnet IDs the workgroup is associated with.
`Workgroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workgroupArn()` The Amazon Resource Name (ARN) that links to the workgroup.
`String`	`workgroupId()` The unique identifier of the workgroup.
`String`	`workgroupName()` The name of the workgroup.

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
  - baseCapacity
```
public final Integer baseCapacity()
```
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    
    Returns:
    
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
  - hasConfigParameters
```
public final boolean hasConfigParameters()
```
    For responses, this returns true if the service returned a value for the ConfigParameters 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.
  - configParameters
```
public final List<ConfigParameter> configParameters()
```
    An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
    
    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 hasConfigParameters() method.
    
    Returns:
    
    An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitivity_identifier, enable_user_activity_logging, query_group, , search_path, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
  - creationDate
```
public final Instant creationDate()
```
    The creation date of the workgroup.
    
    Returns:
    
    The creation date of the workgroup.
  - endpoint
```
public final Endpoint endpoint()
```
    The endpoint that is created from the workgroup.
    
    Returns:
    
    The endpoint that is created from the workgroup.
  - enhancedVpcRouting
```
public final Boolean enhancedVpcRouting()
```
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
    
    Returns:
    
    The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
  - namespaceName
```
public final String namespaceName()
```
    The namespace the workgroup is associated with.
    
    Returns:
    
    The namespace the workgroup is associated with.
  - port
```
public final Integer port()
```
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
    
    Returns:
    
    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
  - publiclyAccessible
```
public final Boolean publiclyAccessible()
```
    A value that specifies whether the workgroup can be accessible from a public network
    
    Returns:
    
    A value that specifies whether the workgroup can be accessible from a public network
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the SecurityGroupIds 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.
  - securityGroupIds
```
public final List<String> securityGroupIds()
```
    An array of security group IDs to associate with the workgroup.
    
    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 hasSecurityGroupIds() method.
    
    Returns:
    
    An array of security group IDs to associate with the workgroup.
  - status
```
public final WorkgroupStatus status()
```
    The status of the workgroup.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorkgroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the workgroup.
    
    See Also:
    
    WorkgroupStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the workgroup.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorkgroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the workgroup.
    
    See Also:
    
    WorkgroupStatus
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds 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.
  - subnetIds
```
public final List<String> subnetIds()
```
    An array of subnet IDs the workgroup is associated with.
    
    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 hasSubnetIds() method.
    
    Returns:
    
    An array of subnet IDs the workgroup is associated with.
  - workgroupArn
```
public final String workgroupArn()
```
    The Amazon Resource Name (ARN) that links to the workgroup.
    
    Returns:
    
    The Amazon Resource Name (ARN) that links to the workgroup.
  - workgroupId
```
public final String workgroupId()
```
    The unique identifier of the workgroup.
    
    Returns:
    
    The unique identifier of the workgroup.
  - workgroupName
```
public final String workgroupName()
```
    The name of the workgroup.
    
    Returns:
    
    The name of the workgroup.
  - toBuilder
```
public Workgroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Workgroup.Builder,Workgroup>
  - builder
```
public static Workgroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Workgroup.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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Workgroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

baseCapacity

hasConfigParameters

configParameters

creationDate

endpoint

enhancedVpcRouting

namespaceName

port

publiclyAccessible

hasSecurityGroupIds

securityGroupIds

status

statusAsString

hasSubnetIds

subnetIds

workgroupArn

workgroupId

workgroupName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields