Class Workgroup

java.lang.Object
software.amazon.awssdk.services.redshiftserverless.model.Workgroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Workgroup.Builder,Workgroup>
@Generated("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:

  • Method Details

    • 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_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, 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_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, 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.

    • hasCrossAccountVpcs

      public final boolean hasCrossAccountVpcs()
      For responses, this returns true if the service returned a value for the CrossAccountVpcs 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.

    • crossAccountVpcs

      public final List<String> crossAccountVpcs()

      A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      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 hasCrossAccountVpcs() method.

      Returns:
      A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

    • customDomainCertificateArn

      public final String customDomainCertificateArn()

      The custom domain name’s certificate Amazon resource name (ARN).

      Returns:
      The custom domain name’s certificate Amazon resource name (ARN).

    • customDomainCertificateExpiryTime

      public final Instant customDomainCertificateExpiryTime()

      The expiration time for the certificate.

      Returns:
      The expiration time for the certificate.

    • customDomainName

      public final String customDomainName()

      The custom domain name associated with the workgroup.

      Returns:
      The custom domain name associated with 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.

    • ipAddressType

      public final String ipAddressType()

      The IP address type that the workgroup supports. Possible values are ipv4 and dualstack .

      Returns:
      The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

    • maxCapacity

      public final Integer maxCapacity()

      The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

      Returns:
      The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

    • namespaceName

      public final String namespaceName()

      The namespace the workgroup is associated with.

      Returns:
      The namespace the workgroup is associated with.

    • patchVersion

      public final String patchVersion()

      The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      Returns:
      The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

    • pendingTrackName

      public final String pendingTrackName()

      The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.

      Returns:
      The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.

    • 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.

    • pricePerformanceTarget

      public final PerformanceTarget pricePerformanceTarget()

      An object that represents the price performance target settings for the workgroup.

      Returns:
      An object that represents the price performance target settings for the workgroup.

    • 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:

    • 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:

    • 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.

    • trackName

      public final String trackName()

      The name of the track for the workgroup.

      Returns:
      The name of the track for the workgroup.

    • 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.

    • workgroupVersion

      public final String workgroupVersion()

      The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

      Returns:
      The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

    • toBuilder

      public Workgroup.Builder 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 interface ToCopyableBuilder<Workgroup.Builder,Workgroup>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.