Class: Orb::Models::MetricCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::MetricCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/metric_create_params.rb

Overview

See Also:

• Resources::Metrics#create

Instance Attribute Summary

• #description ⇒ String^?

  A description of the metric.

• #item_id ⇒ String

  The id of the item.

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

  User-specified key/value pairs for the resource.

• #name ⇒ String

  The name of the metric.

• #sql ⇒ String

  A sql string defining the metric.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(description: , item_id: , name: , sql: , metadata: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see MetricCreateParams 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(description: , item_id: , name: , sql: , metadata: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::MetricCreateParams for more details.

Parameters:

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

  A description of the metric.

• item_id (String) (defaults to: ) —

  The id of the item

• name (String) (defaults to: ) —

  The name of the metric.

• sql (String) (defaults to: ) —

  A sql string defining the metric.

• metadata (Hash{Symbol=>String, nil}, nil) (defaults to: nil) —

  User-specified key/value pairs for the resource. Individual keys can be removed

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

# File 'lib/orb/models/metric_create_params.rb', line 42

Instance Attribute Details

#description ⇒ String^?

A description of the metric.

Returns:

• (String, nil)

# File 'lib/orb/models/metric_create_params.rb', line 14

required :description, String, nil?: true

#item_id ⇒ String

The id of the item

Returns:

• (String)

# File 'lib/orb/models/metric_create_params.rb', line 20

required :item_id, String

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

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to ‘null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.

Returns:

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

# File 'lib/orb/models/metric_create_params.rb', line 40

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

#name ⇒ String

The name of the metric.

Returns:

• (String)

# File 'lib/orb/models/metric_create_params.rb', line 26

required :name, String

#sql ⇒ String

A sql string defining the metric.

Returns:

• (String)

# File 'lib/orb/models/metric_create_params.rb', line 32

required :sql, String