Class: UU::OperationRegistry::GatewayDomainLink

Inherits:
BaseMethods
  • Object
show all
Defined in:
lib/uu/operation_registry/gateway_domain_link.rb

Overview

GatewayDomainLink.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session = nil) ⇒ GatewayDomainLink

Creates a new instance of GatewayDomainLink.

Parameters:

  • session (UU::OS::Security::Session) (defaults to: nil) —

    Session to use for remote calls.



18
19
20
 
# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 18

def initialize(session = nil)
  super
end

Class Method Details

.create(cloud_uri, attributes) ⇒ UU::OS::UESURI

Creates a new gateway domain link. This method is a convenience shortcut for the #create instance method.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

  • attributes (Hash) —

    GatewayDomainLink attributes.

Options Hash (attributes):

  • gatewayUri (UU::OS::UESURI) —

    Gateway URI.

  • domainUri (UU::OS::UESURI) —

    Domain URI.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created gateway domain link.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 34

.delete(gateway_domain_link_uri, parameters = {}) ⇒ void

This method returns an undefined value.

Deletes the specified gateway_domain_link_uri from the registry. This method is a convenience shortcut for the #delete instance method.

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainUri URI.



92
93
94
 
# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 92

def self.delete(gateway_domain_link_uri, parameters = {})
  self.new(UU::OS::Security::Session.current_session).delete(gateway_domain_link_uri, parameters)
end

.get_attributes(gateway_domain_link_uri) ⇒ Hash

Gets the attributes of the gateway domain link specified by gateway domain link URI and returns its detail. This method is a convenience shortcut for the #get_attributes instance method.

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainLink URI.

Returns:

  • (Hash) —

    GatewayDomainLink attributes.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 49

.get_gateway_domain_link_list(cloud_uri, criteria = {}) ⇒ UU::OS::Persistence::PagedResult<Hash>

Returns list of gateway domain links. This method is a convenience shortcut for the #get_gateway_domain_link_list instance method.

Returns:

  • (UU::OS::Persistence::PagedResult<Hash>) —

    Paged result set.

See Also:



118
119
120
 
# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 118

def self.get_gateway_domain_link_list(cloud_uri, criteria = {})
  self.new(UU::OS::Security::Session.current_session).get_gateway_domain_link_list(cloud_uri, criteria)
end

.set_attributes(gateway_domain_link_uri, attributes) ⇒ UU::OS::UESURI

Sets attributes of an gateway domain link. This method is a convenience shortcut for the #set_attributes instance method.

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainLink URI.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated gateway domain link.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 65

Instance Method Details

#create(cloud_uri, attributes) ⇒ UU::OS::UESURI

Creates a new gateway domain link. belongs to.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

  • attributes (Hash) —

    GatewayDomainLink attributes.

Options Hash (attributes):

  • code (String) —

    GatewayDomainLink code. May be nil.

  • description (String) —

    GatewayDomainLink description. May be nil.

  • gatewayUri (UU::OS::UESURI) —

    Resource type GATEWAY URI

  • domainUri (UU::OS::UESURI) —

    Domain URI.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the created gateway domain link.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 22

#delete(gateway_domain_link_uri, parameters = {}) ⇒ void

This method returns an undefined value.

Deletes the specified gateway domain link from the registry.

Examples:

GatewayDomainLink deletion

require "uu_operation_registry"

UU::OS::Security::Session.("operation_registry_authority")

link = UU::OperationRegistry::GatewayDomainLink.new(UU::OS::Security::Session.current_session)
link.delete("ues:OT-BT[99923616732452117]:UUOS9[5819e14581e8a357881e5996]")

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainLink URI.



84
85
86
 
# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 84

def delete(gateway_domain_link_uri, parameters = {})
  client.invoke(:delete, gateway_domain_link_uri, parameters: parameters)
end

#get_attributes(gateway_domain_link_uri) ⇒ Hash

Gets the attributes of the gateway domain link specified by gateway domain link URI and returns its detail.

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainLink URI.

Returns:

  • (Hash) —

    GatewayDomainLink attributes.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 43

#get_gateway_domain_link_list(cloud_uri, criteria = {}) ⇒ UU::OS::Persistence::PagedResult<Hash>

Returns a list of gateway domain links on the given cloud. Command does not return all gateway domain links, only a sublist. The list of returned gateway domain links could be filtered using Mongo Query.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

  • criteria (Hash) (defaults to: {}) —

    Criteria for listing gateway domain links.

Options Hash (criteria):

  • query (String) —

    Mongo Query to filter the result set. See Mongo Query tutorial. Allowed query filter document fields: code, gatewayUri, domainUri

  • pageIndex (Fixnum) —

    Result set page index.

  • pageSize (Fixnum) —

    Result set page size.

Returns:

  • (UU::OS::Persistence::PagedResult<Hash>) —

    Paged result set.



109
110
111
 
# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 109

def get_gateway_domain_link_list(cloud_uri, criteria = {})
  @client.invoke(:getGatewayDomainLinkList, cloud_uri, parameters: criteria)
end

#set_attributes(gateway_domain_link_uri, attributes) ⇒ UU::OS::UESURI

Sets attributes of an gateway domain link.

Parameters:

  • gateway_domain_link_uri (String, UU::OS::UESURI) —

    GatewayDomainLink URI.

  • attributes (Hash) —

    GatewayDomainLink attributes.

Options Hash (attributes):

  • code (String) —

    GatewayDomainLink code. May be nil.

  • description (String) —

    GatewayDomainLink description. May be nil.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the updated gateway domain link.




# File 'lib/uu/operation_registry/gateway_domain_link.rb', line 56