Class: Cadenya::Models::APIKeyUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cadenya::Models::APIKeyUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cadenya/models/api_key_update_params.rb

Overview

See Also:

• Resources::APIKeys#update

Defined Under Namespace

Classes: Metadata

Instance Attribute Summary

• #id ⇒ String
• #metadata ⇒ Cadenya::Models::APIKeyUpdateParams::Metadata^?

  UpdateAccountResourceMetadata contains the user-provided fields for updating an account-scoped resource.

• #spec ⇒ Cadenya::Models::APIKeySpec^?

  Configuration for an API key.

• #update_mask ⇒ String^?

  Fields to update.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Cadenya::Internal::Type::BaseModel

Instance Attribute Details

#id ⇒ String

Returns:

• (String)

# File 'lib/cadenya/models/api_key_update_params.rb', line 13

required :id, String

#metadata ⇒ Cadenya::Models::APIKeyUpdateParams::Metadata^?

UpdateAccountResourceMetadata contains the user-provided fields for updating an account-scoped resource. Read-only fields (id, account_id, profile_id) are excluded since they are set by the server.

Returns:

• (Cadenya::Models::APIKeyUpdateParams::Metadata, nil)

# File 'lib/cadenya/models/api_key_update_params.rb', line 21

optional :metadata, -> { Cadenya::APIKeyUpdateParams::Metadata }

#spec ⇒ Cadenya::Models::APIKeySpec^?

Configuration for an API key.

Returns:

• (Cadenya::Models::APIKeySpec, nil)

# File 'lib/cadenya/models/api_key_update_params.rb', line 27

optional :spec, -> { Cadenya::APIKeySpec }

#update_mask ⇒ String^?

Fields to update.

Returns:

• (String, nil)

# File 'lib/cadenya/models/api_key_update_params.rb', line 33

optional :update_mask, String, api_name: :updateMask