Class: Cerca::Models::ConnectionCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cerca/models/connection_create_params.rb

Overview

See Also:

• Resources::Connections#create

Instance Attribute Summary

• #account_label ⇒ String^?

  Optional human-readable account label.

• #api_key ⇒ String

  API key secret.

• #owner ⇒ Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner

  Public owner for a reusable connection.

• #provider ⇒ String

  Credential provider to store an API key for.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(api_key:, owner:, provider:, account_label: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ConnectionCreateParams 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(api_key:, owner:, provider:, account_label: nil, request_options: {}) ⇒ Object

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

Parameters:

• api_key (String) —

  API key secret. It is stored securely and is not returned.

• owner (Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner) —

  Public owner for a reusable connection. Organization owners use the authenticate

• provider (String) —

  Credential provider to store an API key for.

• account_label (String) (defaults to: nil) —

  Optional human-readable account label.

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

# File 'lib/cerca/models/connection_create_params.rb', line 35

Instance Attribute Details

#account_label ⇒ String^?

Optional human-readable account label.

Returns:

• (String, nil)

# File 'lib/cerca/models/connection_create_params.rb', line 33

optional :account_label, String, api_name: :accountLabel

#api_key ⇒ String

API key secret. It is stored securely and is not returned.

Returns:

• (String)

# File 'lib/cerca/models/connection_create_params.rb', line 14

required :api_key, String, api_name: :apiKey

#owner ⇒ Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner

Public owner for a reusable connection. Organization owners use the authenticated organization; fleet owners add a fleetId.

Returns:

• (Cerca::Models::ConnectionOwner::OrganizationConnectionOwner, Cerca::Models::ConnectionOwner::FleetConnectionOwner)

# File 'lib/cerca/models/connection_create_params.rb', line 21

required :owner, union: -> { Cerca::ConnectionOwner }

#provider ⇒ String

Credential provider to store an API key for.

Returns:

• (String)

# File 'lib/cerca/models/connection_create_params.rb', line 27

required :provider, String