Class: Anthropic::Models::Beta::EnvironmentUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::Beta::EnvironmentUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/beta/environment_update_params.rb,
sig/anthropic/models/beta/environment_update_params.rbs

Overview

See Also:

• Anthropic::Resources::Beta::Environments#update

Defined Under Namespace

Modules: Config, Scope

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

• #betas ⇒ Array<Symbol, String, Anthropic::Models::AnthropicBeta>^?

  Optional header to specify the beta version(s) you want to use.

• #config ⇒ Anthropic::Models::Beta::BetaCloudConfigParams, ...

  Updated environment configuration.

• #description ⇒ String^?

  Updated description of the environment.

• #environment_id ⇒ String
• #metadata ⇒ Hash{Symbol=>String, nil}^?

  User-provided metadata key-value pairs.

• #name ⇒ String^?

  Updated name for the environment.

• #scope ⇒ Symbol, ...

  The visibility scope for this environment.

• #workspace_id ⇒ String^?

  Optional header to select the Workspace for this request.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(environment_id:, config: nil, description: nil, metadata: nil, name: nil, scope: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void constructor

  Some parameter documentations has been truncated, see EnvironmentUpdateParams 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(environment_id:, config: nil, description: nil, metadata: nil, name: nil, scope: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::EnvironmentUpdateParams for more details.

Parameters:

• (defaults to: nil)

  Updated environment configuration

• (defaults to: nil)

  Updated description of the environment. Omit to preserve; null clears to null; a

• (defaults to: nil)

  User-provided metadata key-value pairs. Set a value to null or empty string to d

• (defaults to: nil)

  Updated name for the environment

• (defaults to: nil)

  The visibility scope for this environment. 'organization' makes the environment

• (defaults to: nil)

  Optional header to specify the beta version(s) you want to use.

• (defaults to: nil)

  Optional header to select the Workspace for this request. The value is a Workspa

• (defaults to: {})

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 67

Instance Attribute Details

#betas ⇒ Array<Symbol, String, Anthropic::Models::AnthropicBeta>^?

Optional header to specify the beta version(s) you want to use.

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 54

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#config ⇒ Anthropic::Models::Beta::BetaCloudConfigParams, ...

Updated environment configuration

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 20

optional :config, union: -> { Anthropic::Beta::EnvironmentUpdateParams::Config }, nil?: true

#description ⇒ String^?

Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 27

optional :description, String, nil?: true

#environment_id ⇒ String

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 14

required :environment_id, String

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

User-provided metadata key-value pairs. Set a value to null or empty string to delete the key.

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 34

optional :metadata, Anthropic::Internal::Type::HashOf[String, nil?: true]

#name ⇒ String^?

Updated name for the environment

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 40

optional :name, String, nil?: true

#scope ⇒ Symbol, ...

The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only.

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 48

optional :scope, enum: -> { Anthropic::Beta::EnvironmentUpdateParams::Scope }, nil?: true

#workspace_id ⇒ String^?

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Parameters:

Returns:

# File 'lib/anthropic/models/beta/environment_update_params.rb', line 65

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

# File 'sig/anthropic/models/beta/environment_update_params.rbs', line 57

def to_hash: -> {