Class: ApolloDeploySignalSdk::UpdateTopicBody

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk/types.rb

Overview

Schema type: UpdateTopicBody

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, description: nil, visibility: nil) ⇒ UpdateTopicBody

Returns a new instance of UpdateTopicBody.

Parameters:

  • name (String, nil) (defaults to: nil)

    , description [String, nil], visibility [String, nil]



2327
2328
2329
2330
2331
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2327

def initialize(name: nil, description: nil, visibility: nil)
  @name = name
  @description = description
  @visibility = visibility
end

Instance Attribute Details

#descriptionString?

Returns:

  • (String, nil)


2322
2323
2324
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2322

def description
  @description
end

#nameString?

Returns:

  • (String, nil)


2320
2321
2322
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2320

def name
  @name
end

#visibilityString?

Returns:

  • (String, nil)


2324
2325
2326
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2324

def visibility
  @visibility
end

Class Method Details

.from_json(attributes) ⇒ UpdateTopicBody

Create an instance from a parsed JSON hash.

Parameters:

  • attributes (Hash)

Returns:



2345
2346
2347
2348
2349
2350
2351
2352
2353
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2345

def self.from_json(attributes)
  return nil unless attributes.is_a?(Hash)

  new(
    name: attributes.key?("name") ? attributes["name"] : attributes[:name],
    description: attributes.key?("description") ? attributes["description"] : attributes[:description],
    visibility: attributes.key?("visibility") ? attributes["visibility"] : attributes[:visibility],
  )
end

Instance Method Details

#to_hHash

Returns a hash representation of this object.

Returns:

  • (Hash)

    a hash representation of this object



2334
2335
2336
2337
2338
2339
2340
# File 'lib/apollo_deploy_signal_sdk/types.rb', line 2334

def to_h
  {
    name: @name,
    description: @description,
    visibility: @visibility,
  }.compact
end