Class: Anthropic::Models::Organization::Workspaces::RateLimitListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::Organization::Workspaces::RateLimitListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb,
sig/anthropic/models/organization/workspaces/rate_limit_list_params.rbs

Overview

See Also:

• Anthropic::Resources::Organization::Workspaces::RateLimits#list

Defined Under Namespace

Modules: GroupType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

• #group_type ⇒ Symbol, ...

  Filter by group type.

• #include_inherited ⇒ Boolean^?

  Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.

• #limit ⇒ Integer^?

  Maximum number of items to return per page.

• #page ⇒ String^?

  Opaque cursor from a previous response's next_page.

• #workspace_id ⇒ String

  The ID of the workspace.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(workspace_id:, group_type: nil, include_inherited: nil, limit: nil, page: nil, request_options: {}) ⇒ void constructor

  Some parameter documentations has been truncated, see RateLimitListParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(workspace_id:, group_type: nil, include_inherited: nil, limit: nil, page: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Organization::Workspaces::RateLimitListParams for more details.

Parameters:

• workspace_id (String) —

  The ID of the workspace.

• group_type (Symbol, Anthropic::Models::Organization::Workspaces::RateLimitListParams::GroupType, nil) (defaults to: nil) —

  Filter by group type.

• include_inherited (Boolean) (defaults to: nil) —

  Also list the limiter values the workspace inherits from the organization, inclu

• limit (Integer, nil) (defaults to: nil) —

  Maximum number of items to return per page. Ranges from 1 to 1000.

• page (String, nil) (defaults to: nil) —

  Opaque cursor from a previous response's next_page.

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 48

Instance Attribute Details

#group_type ⇒ Symbol, ...

Filter by group type.

Parameters:

• value (Anthropic::Models::Organization::Workspaces::RateLimitListParams::group_type, nil)

Returns:

• (Symbol, Anthropic::Models::Organization::Workspaces::RateLimitListParams::GroupType, nil)

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 22

optional :group_type,
enum: -> { Anthropic::Organization::Workspaces::RateLimitListParams::GroupType },
nil?: true

#include_inherited ⇒ Boolean^?

Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 31

optional :include_inherited, Anthropic::Internal::Type::Boolean

#limit ⇒ Integer^?

Maximum number of items to return per page. Ranges from 1 to 1000.

When omitted, every remaining entry is returned in a single page and next_page is null.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 40

optional :limit, Integer, nil?: true

#page ⇒ String^?

Opaque cursor from a previous response's next_page.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 46

optional :page, String, nil?: true

#workspace_id ⇒ String

The ID of the workspace.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/anthropic/models/organization/workspaces/rate_limit_list_params.rb', line 16

required :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/anthropic/models/organization/workspaces/rate_limit_list_params.rbs', line 40

def to_hash: -> {