Package software.amazon.awssdk.services.glue.model

Class GetDatabasesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.GetDatabasesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDatabasesRequest.Builder,GetDatabasesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetDatabasesRequest extends GlueRequest implements ToCopyableBuilder<GetDatabasesRequest.Builder,GetDatabasesRequest>

  • Method Details

    • catalogId

      public final String catalogId()

      The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

      Returns:
      The ID of the Data Catalog from which to retrieve Databases. If none is provided, the Amazon Web Services account ID is used by default.

    • nextToken

      public final String nextToken()

      A continuation token, if this is a continuation call.

      Returns:
      A continuation token, if this is a continuation call.

    • maxResults

      public final Integer maxResults()

      The maximum number of databases to return in one response.

      Returns:
      The maximum number of databases to return in one response.

    • resourceShareType

      public final ResourceShareType resourceShareType()

      Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

      • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

      • If set to FOREIGN, will list the databases shared with your account.

      • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

      If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

      Returns:
      Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

      • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

      • If set to FOREIGN, will list the databases shared with your account.

      • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

      See Also:

    • resourceShareTypeAsString

      public final String resourceShareTypeAsString()

      Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

      • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

      • If set to FOREIGN, will list the databases shared with your account.

      • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

      If the service returns an enum value that is not available in the current SDK version, resourceShareType will return ResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceShareTypeAsString().

      Returns:
      Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.

      • If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.

      • If set to FOREIGN, will list the databases shared with your account.

      • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

      See Also:

    • attributesToGet

      public final List<DatabaseAttributes> attributesToGet()

      Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

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

      Returns:
      Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

    • hasAttributesToGet

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

    • attributesToGetAsStrings

      public final List<String> attributesToGetAsStrings()

      Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

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

      Returns:
      Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.

    • toBuilder

      public GetDatabasesRequest.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<GetDatabasesRequest.Builder,GetDatabasesRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static GetDatabasesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDatabasesRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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