You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::GetPartitionsRequest

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

Overview

Note:

When making an API call, you may pass GetPartitionsRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  database_name: "NameString", # required
  table_name: "NameString", # required
  expression: "PredicateString",
  next_token: "Token",
  segment: {
    segment_number: 1, # required
    total_segments: 1, # required
  },
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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

Returns:

  • (String)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#database_nameString

The name of the catalog database where the partitions reside.

Returns:

  • (String)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#expressionString

An expression filtering the partitions to be returned.

Returns:

  • (String)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#segmentTypes::Segment

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

Returns:



3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end

#table_nameString

The name of the partitions' table.

Returns:

  • (String)


3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3079

class GetPartitionsRequest < Struct.new(
  :catalog_id,
  :database_name,
  :table_name,
  :expression,
  :next_token,
  :segment,
  :max_results)
  include Aws::Structure
end