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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetEntityRecordsRequest.Builder,GetEntityRecordsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetEntityRecordsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetEntityRecordsRequest.Builder`	`builder()`
`String`	`catalogId()`	The catalog ID of the catalog that contains the connection.
`String`	`connectionName()`	The name of the connection that contains the connection type credentials.
`Map<String,String>`	`connectionOptions()`	Connector options that are required to query the data.
`String`	`dataStoreApiVersion()`	The API version of the SaaS connector.
`String`	`entityName()`	Name of the entity that we want to query the preview data from the given connection type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`filterPredicate()`	A filter predicate that you can apply in the query request.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConnectionOptions()`	For responses, this returns true if the service returned a value for the ConnectionOptions property.
`int`	`hashCode()`
`boolean`	`hasSelectedFields()`	For responses, this returns true if the service returned a value for the SelectedFields property.
`Long`	`limit()`	Limits the number of records fetched with the request.
`String`	`nextToken()`	A continuation token, included if this is a continuation call.
`String`	`orderBy()`	A parameter that orders the response preview data.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`selectedFields()`	List of fields that we want to fetch as part of preview data.
`static Class<? extends GetEntityRecordsRequest.Builder>`	`serializableBuilderClass()`
`GetEntityRecordsRequest.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
  - connectionName
```
public final String connectionName()
```
    The name of the connection that contains the connection type credentials.
    
    Returns:
    
    The name of the connection that contains the connection type credentials.
  - catalogId
```
public final String catalogId()
```
    The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
    
    Returns:
    
    The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
  - entityName
```
public final String entityName()
```
    Name of the entity that we want to query the preview data from the given connection type.
    
    Returns:
    
    Name of the entity that we want to query the preview data from the given connection type.
  - nextToken
```
public final String nextToken()
```
    A continuation token, included if this is a continuation call.
    
    Returns:
    
    A continuation token, included if this is a continuation call.
  - dataStoreApiVersion
```
public final String dataStoreApiVersion()
```
    The API version of the SaaS connector.
    
    Returns:
    
    The API version of the SaaS connector.
  - hasConnectionOptions
```
public final boolean hasConnectionOptions()
```
    For responses, this returns true if the service returned a value for the ConnectionOptions 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.
  - connectionOptions
```
public final Map<String,String> connectionOptions()
```
    Connector options that are required to query the data.
    
    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 hasConnectionOptions() method.
    
    Returns:
    
    Connector options that are required to query the data.
  - filterPredicate
```
public final String filterPredicate()
```
    A filter predicate that you can apply in the query request.
    
    Returns:
    
    A filter predicate that you can apply in the query request.
  - limit
```
public final Long limit()
```
    Limits the number of records fetched with the request.
    
    Returns:
    
    Limits the number of records fetched with the request.
  - orderBy
```
public final String orderBy()
```
    A parameter that orders the response preview data.
    
    Returns:
    
    A parameter that orders the response preview data.
  - hasSelectedFields
```
public final boolean hasSelectedFields()
```
    For responses, this returns true if the service returned a value for the SelectedFields 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.
  - selectedFields
```
public final List<String> selectedFields()
```
    List of fields that we want to fetch as part of preview data.
    
    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 hasSelectedFields() method.
    
    Returns:
    
    List of fields that we want to fetch as part of preview data.
  - toBuilder
```
public GetEntityRecordsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetEntityRecordsRequest.Builder,GetEntityRecordsRequest>
    
    Specified by:
    
    toBuilder in class GlueRequest
  - builder
```
public static GetEntityRecordsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetEntityRecordsRequest.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

Class GetEntityRecordsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

connectionName

catalogId

entityName

nextToken

dataStoreApiVersion

hasConnectionOptions

connectionOptions

filterPredicate

limit

orderBy

hasSelectedFields

selectedFields

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField