Class: Com::Vmware::Vapi::Metadata::Authentication::Source

Inherits:
VAPI::Bindings::VapiService
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb

Overview

The ``Com::Vmware::Vapi::Metadata::Authentication::Source`` class provides methods to manage the sources of authentication metadata information. 


 The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains authentication information. The generated file can be registered as a source of metadata.  

 The authentication file contains all the data present in the interface definition files. Each authentication file contains data about one component element. When a authentication file is added as a source, each source contributes only one component element's metadata.  

 Authentication metadata can also be discovered from a remote server that supports the authentication metadata  classs  (see   :mod:`com.vmware.vapi.metadata.authentication`  ). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Defined Under Namespace

Classes: CreateSpec, Info

Constant Summary

RESOURCE_TYPE = 
'com.vmware.vapi.metadata.authentication.source'

Instance Method Summary (collapse)

Constructor Details

- (Source) initialize(config)

Constructs a new instance.

Parameters:

  • config (VAPI::Bindings::StubConfig) —

    A hash with the api provider details. 



379
380
381
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 379

def initialize(config)
    super(config, @@service_info)
end

Instance Method Details

- (Void) create(source_id, spec)

Creates a new metadata source. Once the server validates the registration information of the metadata source, the authentication metadata is retrieved from the source. This populates elements in all the classs defined in :mod:`com.vmware.vapi.metadata.authentication` package .

Parameters:

Returns:

  • (Void)

Raises:



403
404
405
406
407
408
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 403

def create(source_id, spec)
    invoke_with_info(@@create_info, {
        'source_id' => source_id,
        'spec' => spec,
    })
end

- (Void) delete(source_id)

Deletes an existing authentication metadata source from the infrastructure.

Parameters:

  • source_id (String) —

    Identifier of the metadata source.

Returns:

  • (Void)

Raises:



418
419
420
421
422
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 418

def delete(source_id)
    invoke_with_info(@@delete_info, {
        'source_id' => source_id,
    })
end

- (String) fingerprint(source_id = nil)

Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if ``source_id`` is specified.

Parameters:

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

    Identifier of the metadata source. If unspecified, the fingerprint of all the metadata sources is returned.

Returns:

  • (String) —

    Aggregate fingerprint of all the metadata sources or of a particular metadata source.

Raises:



473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 473

def fingerprint(source_id=nil)
    invoke_with_info(@@fingerprint_info, {
        'source_id' => source_id,
    })
end

- (Com::Vmware::Vapi::Metadata::Authentication::Source::Info) get(source_id)

Retrieves information about the metadata source corresponding to ``source_id`` .

Parameters:

  • source_id (String) —

    Identifier of the metadata source.

Returns:

Raises:



433
434
435
436
437
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 433

def get(source_id)
    invoke_with_info(@@get_info, {
        'source_id' => source_id,
    })
end

- (Array<String>) list

Returns the identifiers of the metadata sources currently registered with the infrastructure.

Returns:

  • (Array<String>) —

    The list of identifiers for metadata sources currently registered. 



444
445
446
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 444

def list()
    invoke_with_info(@@list_info)
end

- (Void) reload(source_id = nil)

Reloads the authentication metadata from all the metadata sources or of a particular metadata source if ``source_id`` is specified.

Parameters:

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

    Identifier of the metadata source. If unspecified, all the metadata sources are reloaded.

Returns:

  • (Void)

Raises:



457
458
459
460
461
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 457

def reload(source_id=nil)
    invoke_with_info(@@reload_info, {
        'source_id' => source_id,
    })
end