Class: NgrokAPI::Models::SSHCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/models/ssh_credential.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client: nil, attrs: {}) ⇒ SSHCredential

Returns a new instance of SSHCredential.



16
17
18
19
20
21
22
23
24
25
26
# File 'lib/ngrokapi/models/ssh_credential.rb', line 16

def initialize(client: nil, attrs: {})
  @client = client
  @attrs = attrs
  @id = @attrs['id']
  @uri = @attrs['uri']
  @created_at = @attrs['created_at']
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @public_key = @attrs['public_key']
  @acl = @attrs['acl']
end

Instance Attribute Details

#aclObject (readonly)

Returns the value of attribute acl.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def acl
  @acl
end

#attrsObject (readonly)

Returns the value of attribute attrs.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def attrs
  @attrs
end

#clientObject (readonly)

Returns the value of attribute client.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def client
  @client
end

#created_atObject (readonly)

Returns the value of attribute created_at.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def created_at
  @created_at
end

#descriptionObject (readonly)

Returns the value of attribute description.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def description
  @description
end

#idObject (readonly)

Returns the value of attribute id.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def id
  @id
end

#metadataObject (readonly)

Returns the value of attribute metadata.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def 
  @metadata
end

#public_keyObject (readonly)

Returns the value of attribute public_key.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def public_key
  @public_key
end

#uriObject (readonly)

Returns the value of attribute uri.



6
7
8
# File 'lib/ngrokapi/models/ssh_credential.rb', line 6

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object



28
29
30
# File 'lib/ngrokapi/models/ssh_credential.rb', line 28

def ==(other)
  @attrs == other.attrs
end

#deleteObject

Delete an ssh_credential by ID

ngrok.com/docs/api#api-ssh-credentials-delete



44
45
46
47
48
# File 'lib/ngrokapi/models/ssh_credential.rb', line 44

def delete
  @client.delete(
    id: @id
  )
end

#to_hObject



36
37
38
# File 'lib/ngrokapi/models/ssh_credential.rb', line 36

def to_h
  @attrs.to_h
end

#to_sObject



32
33
34
# File 'lib/ngrokapi/models/ssh_credential.rb', line 32

def to_s
  @attrs.to_s
end

#update(description: nil, metadata: nil, acl: nil) ⇒ Object

Update attributes of an ssh_credential by ID

ngrok.com/docs/api#api-ssh-credentials-update



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/ngrokapi/models/ssh_credential.rb', line 54

def update(
  description: nil,
  metadata: nil,
  acl: nil
)
  @description = description if description
  @metadata =  if 
  @acl = acl if acl
  @client.update(
    id: @id,
    description: description,
    metadata: ,
    acl: acl
  )
end