Class: Aws::Glue::Types::GetUnfilteredPartitionsMetadataRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-glue/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_contextTypes::AuditContext

A structure containing Lake Formation audit context information.

Returns:



12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_idString

The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The name of the catalog database where the partitions reside.

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#expressionString

An expression that filters the partitions to be returned.

The expression uses SQL syntax similar to the SQL ‘WHERE` filter clause. The SQL statement parser [JSQLParser] parses the expression.

Operators: The following are the operators that you can use in the ‘Expression` API call:

: Checks whether the values of the two operands are equal; if yes,

then the condition becomes true.

Example: Assume 'variable a' holds 10 and 'variable b' holds
20.

(a = b) is not true.

&lt; &gt;

: Checks whether the values of two operands are equal; if the values

are not equal, then the condition becomes true.

Example: (a &lt; &gt; b) is true.

&gt;

: Checks whether the value of the left operand is greater than the

value of the right operand; if yes, then the condition becomes
true.

Example: (a &gt; b) is not true.

&lt;

: Checks whether the value of the left operand is less than the

value of the right operand; if yes, then the condition becomes
true.

Example: (a &lt; b) is true.

&gt;=

: Checks whether the value of the left operand is greater than or

equal to the value of the right operand; if yes, then the
condition becomes true.

Example: (a &gt;= b) is not true.

&lt;=

: Checks whether the value of the left operand is less than or equal

to the value of the right operand; if yes, then the condition
becomes true.

Example: (a &lt;= b) is true.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

: Logical operators.

*Supported Partition Key Types*: The following are the supported partition keys.

  • ‘string`

  • ‘date`

  • ‘timestamp`

  • ‘int`

  • ‘bigint`

  • ‘long`

  • ‘tinyint`

  • ‘smallint`

  • ‘decimal`

If an type is encountered that is not valid, an exception is thrown.

[1]: jsqlparser.sourceforge.net/home.php

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of partitions to return in a single response.

Returns:

  • (Integer)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A continuation token, if this is not the first call to retrieve these partitions.

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#query_session_contextTypes::QuerySessionContext

A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.



12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

Specified only if the base tables belong to a different Amazon Web Services Region.

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#segmentTypes::Segment

The segment of the table’s partitions to scan in this request.

Returns:



12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#supported_permission_typesArray<String>

A list of supported permission types.

Returns:

  • (Array<String>)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end

#table_nameString

The name of the table that contains the partition.

Returns:

  • (String)


12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
# File 'lib/aws-sdk-glue/types.rb', line 12221

class GetUnfilteredPartitionsMetadataRequest < Struct.new(
  :region,
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :audit_context,
  :supported_permission_types,
  :next_token,
  :segment,
  :max_results,
  :query_session_context)
  SENSITIVE = []
  include Aws::Structure
end