Interface GetEntityRecordsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<GetEntityRecordsRequest.Builder,GetEntityRecordsRequest>,GlueRequest.Builder,SdkBuilder<GetEntityRecordsRequest.Builder,GetEntityRecordsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- GetEntityRecordsRequest
public static interface GetEntityRecordsRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<GetEntityRecordsRequest.Builder,GetEntityRecordsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetEntityRecordsRequest.BuildercatalogId(String catalogId)The catalog ID of the catalog that contains the connection.GetEntityRecordsRequest.BuilderconnectionName(String connectionName)The name of the connection that contains the connection type credentials.GetEntityRecordsRequest.BuilderconnectionOptions(Map<String,String> connectionOptions)Connector options that are required to query the data.GetEntityRecordsRequest.BuilderdataStoreApiVersion(String dataStoreApiVersion)The API version of the SaaS connector.GetEntityRecordsRequest.BuilderentityName(String entityName)Name of the entity that we want to query the preview data from the given connection type.GetEntityRecordsRequest.BuilderfilterPredicate(String filterPredicate)A filter predicate that you can apply in the query request.GetEntityRecordsRequest.Builderlimit(Long limit)Limits the number of records fetched with the request.GetEntityRecordsRequest.BuildernextToken(String nextToken)A continuation token, included if this is a continuation call.GetEntityRecordsRequest.BuilderorderBy(String orderBy)A parameter that orders the response preview data.GetEntityRecordsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)GetEntityRecordsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)GetEntityRecordsRequest.BuilderselectedFields(String... selectedFields)List of fields that we want to fetch as part of preview data.GetEntityRecordsRequest.BuilderselectedFields(Collection<String> selectedFields)List of fields that we want to fetch as part of preview data.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
connectionName
GetEntityRecordsRequest.Builder connectionName(String connectionName)
The name of the connection that contains the connection type credentials.
- Parameters:
connectionName- The name of the connection that contains the connection type credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
catalogId
GetEntityRecordsRequest.Builder catalogId(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
entityName
GetEntityRecordsRequest.Builder entityName(String entityName)
Name of the entity that we want to query the preview data from the given connection type.
- Parameters:
entityName- Name of the entity that we want to query the preview data from the given connection type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
GetEntityRecordsRequest.Builder nextToken(String nextToken)
A continuation token, included if this is a continuation call.
- Parameters:
nextToken- A continuation token, included if this is a continuation call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataStoreApiVersion
GetEntityRecordsRequest.Builder dataStoreApiVersion(String dataStoreApiVersion)
The API version of the SaaS connector.
- Parameters:
dataStoreApiVersion- The API version of the SaaS connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionOptions
GetEntityRecordsRequest.Builder connectionOptions(Map<String,String> connectionOptions)
Connector options that are required to query the data.
- Parameters:
connectionOptions- Connector options that are required to query the data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterPredicate
GetEntityRecordsRequest.Builder filterPredicate(String filterPredicate)
A filter predicate that you can apply in the query request.
- Parameters:
filterPredicate- A filter predicate that you can apply in the query request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limit
GetEntityRecordsRequest.Builder limit(Long limit)
Limits the number of records fetched with the request.
- Parameters:
limit- Limits the number of records fetched with the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
orderBy
GetEntityRecordsRequest.Builder orderBy(String orderBy)
A parameter that orders the response preview data.
- Parameters:
orderBy- A parameter that orders the response preview data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectedFields
GetEntityRecordsRequest.Builder selectedFields(Collection<String> selectedFields)
List of fields that we want to fetch as part of preview data.
- Parameters:
selectedFields- List of fields that we want to fetch as part of preview data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectedFields
GetEntityRecordsRequest.Builder selectedFields(String... selectedFields)
List of fields that we want to fetch as part of preview data.
- Parameters:
selectedFields- List of fields that we want to fetch as part of preview data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetEntityRecordsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
GetEntityRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-