Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::Authentication::Package

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vapi::Metadata::Authentication::Package
  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::Package`` class provides methods to retrieve authentication information of a package element.

     A package element is said to contain authentication information if there is a default authentication assigned to all service elements contained in the package element or if one of the service element contained in this package element has authentication information.

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vapi.package'

## Instance Method Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Authentication::PackageInfo) get(package_id)

  Retrieves authentication information about the package element corresponding to ``package_id`` .

- - (Package) initialize(config) constructor

  Constructs a new instance.

- - (Array<String>) list

  Returns the identifiers for the package elements that have authentication information.

## Constructor Details

### - (`Package`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    172
    173
    174
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 172

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

## Instance Method Details

### - (`Com::Vmware::Vapi::Metadata::Authentication::PackageInfo`) get(package_id)

Retrieves authentication information about the package element corresponding to ``package_id`` .

Parameters:

- package_id (`String`) —

  Identifier of the package element.

Returns:

- (`Com::Vmware::Vapi::Metadata::Authentication::PackageInfo`) —

  The :class:`Com::Vmware::Vapi::Metadata::Authentication::PackageInfo` instance that corresponds to ``package_id``

Raises:

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the package element associated with ``package_id`` does not have any authentication information.

    196
    197
    198
    199
    200
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 196

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

### - (`Array<String>`) list

Returns the identifiers for the package elements that have authentication information.

Returns:

- (`Array<String>`) —

  The list of identifiers for the package elements that have authentication information.

    183
    184
    185
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 183

    def list()
        invoke_with_info(@@list_info)
    end