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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetDatabasesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<DatabaseAttributes>attributesToGet()Specifies the database fields returned by theGetDatabasescall.List<String>attributesToGetAsStrings()Specifies the database fields returned by theGetDatabasescall.static GetDatabasesRequest.Builderbuilder()StringcatalogId()The ID of the Data Catalog from which to retrieveDatabases.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributesToGet()For responses, this returns true if the service returned a value for the AttributesToGet property.inthashCode()IntegermaxResults()The maximum number of databases to return in one response.StringnextToken()A continuation token, if this is a continuation call.ResourceShareTyperesourceShareType()Allows you to specify that you want to list the databases shared with your account.StringresourceShareTypeAsString()Allows you to specify that you want to list the databases shared with your account.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetDatabasesRequest.Builder>serializableBuilderClass()GetDatabasesRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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,FOREIGNorALL.-
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,
resourceShareTypewill returnResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceShareTypeAsString().- Returns:
- Allows you to specify that you want to list the databases shared with your account. The allowable values
are
FEDERATED,FOREIGNorALL.-
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:
ResourceShareType
-
-
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,FOREIGNorALL.-
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,
resourceShareTypewill returnResourceShareType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceShareTypeAsString().- Returns:
- Allows you to specify that you want to list the databases shared with your account. The allowable values
are
FEDERATED,FOREIGNorALL.-
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:
ResourceShareType
-
-
attributesToGet
public final List<DatabaseAttributes> attributesToGet()
Specifies the database fields returned by the
GetDatabasescall. This parameter doesn’t accept an empty list. The request must include theNAME.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
GetDatabasescall. This parameter doesn’t accept an empty list. The request must include theNAME.
-
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 theisEmpty()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
GetDatabasescall. This parameter doesn’t accept an empty list. The request must include theNAME.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
GetDatabasescall. This parameter doesn’t accept an empty list. The request must include theNAME.
-
toBuilder
public GetDatabasesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetDatabasesRequest.Builder,GetDatabasesRequest>- Specified by:
toBuilderin classGlueRequest
-
builder
public static GetDatabasesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDatabasesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-