Class: Aws::Glue::Types::GetEntityRecordsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::GetEntityRecordsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-glue/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog_id ⇒ String

  The catalog ID of the catalog that contains the connection.

• #connection_name ⇒ String

  The name of the connection that contains the connection type credentials.

• #connection_options ⇒ Hash<String,String>

  Connector options that are required to query the data.

• #data_store_api_version ⇒ String

  The API version of the SaaS connector.

• #entity_name ⇒ String

  Name of the entity that we want to query the preview data from the given connection type.

• #filter_predicate ⇒ String

  A filter predicate that you can apply in the query request.

• #limit ⇒ Integer

  Limits the number of records fetched with the request.

• #next_token ⇒ String

  A continuation token, included if this is a continuation call.

• #order_by ⇒ String

  A parameter that orders the response preview data.

• #selected_fields ⇒ Array<String>

  List of fields that we want to fetch as part of preview data.

Instance Attribute Details

#catalog_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#connection_name ⇒ String

The name of the connection that contains the connection type credentials.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#connection_options ⇒ Hash<String,String>

Connector options that are required to query the data.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#data_store_api_version ⇒ String

The API version of the SaaS connector.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#entity_name ⇒ String

Name of the entity that we want to query the preview data from the given connection type.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#filter_predicate ⇒ String

A filter predicate that you can apply in the query request.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

Limits the number of records fetched with the request.

Returns:

• (Integer)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A continuation token, included if this is a continuation call.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#order_by ⇒ String

A parameter that orders the response preview data.

Returns:

• (String)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end

#selected_fields ⇒ Array<String>

List of fields that we want to fetch as part of preview data.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-glue/types.rb', line 12664

class GetEntityRecordsRequest < Struct.new(
  :connection_name,
  :catalog_id,
  :entity_name,
  :next_token,
  :data_store_api_version,
  :connection_options,
  :filter_predicate,
  :limit,
  :order_by,
  :selected_fields)
  SENSITIVE = []
  include Aws::Structure
end