software.amazon.awssdk.services.redshiftserverless.model

Class UpdateWorkgroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest

software.amazon.awssdk.services.redshiftserverless.model.UpdateWorkgroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWorkgroupRequest.Builder,UpdateWorkgroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateWorkgroupRequest
extends RedshiftServerlessRequest
implements ToCopyableBuilder<UpdateWorkgroupRequest.Builder,UpdateWorkgroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateWorkgroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
Integer	baseCapacity() The new base data warehouse capacity in Redshift Processing Units (RPUs).
static UpdateWorkgroupRequest.Builder	builder()
List<ConfigParameter>	configParameters() An array of parameters to set for advanced control over a database.
Boolean	enhancedVpcRouting() The value that specifies whether to turn on 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.
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 UpdateWorkgroupRequest.Builder>	serializableBuilderClass()
List<String>	subnetIds() An array of VPC subnet IDs to associate with the workgroup.
UpdateWorkgroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workgroupName() The name of the workgroup to update.

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

baseCapacity

public final Integer baseCapacity()

The new base data warehouse capacity in Redshift Processing Units (RPUs).

Returns:

The new base data warehouse capacity 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.

enhancedVpcRouting

public final Boolean enhancedVpcRouting()

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

Returns:

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

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.

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 VPC subnet 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 hasSubnetIds() method.

Returns:

An array of VPC subnet IDs to associate with the workgroup.

workgroupName

public final String workgroupName()

The name of the workgroup to update. You can't update the name of a workgroup once it is created.

Returns:

The name of the workgroup to update. You can't update the name of a workgroup once it is created.

toBuilder

public UpdateWorkgroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWorkgroupRequest.Builder,UpdateWorkgroupRequest>

Specified by:

toBuilder in class RedshiftServerlessRequest

builder

public static UpdateWorkgroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateWorkgroupRequest.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