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

Class GetCatalogsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetCatalogsRequest
extends GlueRequest
implements ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCatalogsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetCatalogsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeRoot()	Whether to list the default catalog in the account and region in the response.
Integer	maxResults()	The maximum number of catalogs to return in one response.
String	nextToken()	A continuation token, if this is a continuation call.
String	parentCatalogId()	The ID of the parent catalog in which the catalog resides.
Boolean	recursive()	Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetCatalogsRequest.Builder>	serializableBuilderClass()
GetCatalogsRequest.Builder	toBuilder()
String	toString()	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

parentCatalogId

public final String parentCatalogId()

The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number is used by default.

Returns:

The ID of the parent catalog in which the catalog resides. If none is provided, the Amazon Web Services Account Number 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 catalogs to return in one response.

Returns:

The maximum number of catalogs to return in one response.

recursive

public final Boolean recursive()

Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId. Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.

Returns:

Whether to list all catalogs across the catalog hierarchy, starting from the ParentCatalogId . Defaults to false . When true, all catalog objects in the ParentCatalogID hierarchy are enumerated in the response.

includeRoot

public final Boolean includeRoot()

Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ParentCatalogId = NULL | Amazon Web Services Account ID, all catalogs and the default catalog are enumerated in the response.

When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.

Returns:

Whether to list the default catalog in the account and region in the response. Defaults to false. When true and ParentCatalogId = NULL | Amazon Web Services Account ID, all catalogs and the default catalog are enumerated in the response.

When the ParentCatalogId is not equal to null, and this attribute is passed as false or true, an InvalidInputException is thrown.

toBuilder

public GetCatalogsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCatalogsRequest.Builder,GetCatalogsRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static GetCatalogsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo