Class: Cerca::Models::AgentCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::AgentCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cerca/models/agent_create_params.rb

Overview

See Also:

• Resources::Agents#create

Instance Attribute Summary

• #configuration ⇒ Cerca::Models::Configuration^?
• #fleet_id ⇒ String^?
• #metadata ⇒ Hash{Symbol=>String}^?

  Arbitrary string metadata stored on an agent.

• #user_id ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(configuration: nil, fleet_id: nil, metadata: nil, user_id: nil, request_options: {}) ⇒ Object constructor

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

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(configuration: nil, fleet_id: nil, metadata: nil, user_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Cerca::Models::AgentCreateParams for more details.

Parameters:

• configuration (Cerca::Models::Configuration) (defaults to: nil)
• fleet_id (String) (defaults to: nil)
• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Arbitrary string metadata stored on an agent. Runtime enforces maximum key and v

• user_id (String) (defaults to: nil)
• request_options (Cerca::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/cerca/models/agent_create_params.rb', line 32

Instance Attribute Details

#configuration ⇒ Cerca::Models::Configuration^?

Returns:

• (Cerca::Models::Configuration, nil)

# File 'lib/cerca/models/agent_create_params.rb', line 13

optional :configuration, -> { Cerca::Configuration }

#fleet_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/cerca/models/agent_create_params.rb', line 18

optional :fleet_id, String, api_name: :fleetId

#metadata ⇒ Hash{Symbol=>String}^?

Arbitrary string metadata stored on an agent. Runtime enforces maximum key and value sizes.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/cerca/models/agent_create_params.rb', line 25

optional :metadata, Cerca::Internal::Type::HashOf[String]

#user_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/cerca/models/agent_create_params.rb', line 30

optional :user_id, String, api_name: :userId