Class: VSphereAutomation::VCenter::StoragePoliciesComplianceApi
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::StoragePoliciesComplianceApi
- Defined in:
- lib/vsphere-automation-vcenter/api/storage_policies_compliance_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ StoragePoliciesComplianceApi
constructor
A new instance of StoragePoliciesComplianceApi.
-
#list(opts = {}) ⇒ VcenterStoragePoliciesComplianceListResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns compliance information about entities matching the filter Compliance.FilterSpec.
-
#list_with_http_info(opts = {}) ⇒ Array<(VcenterStoragePoliciesComplianceListResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns compliance information about entities matching the filter Compliance.FilterSpec.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ StoragePoliciesComplianceApi
Returns a new instance of StoragePoliciesComplianceApi.
16 17 18 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_compliance_api.rb', line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
14 15 16 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_compliance_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#list(opts = {}) ⇒ VcenterStoragePoliciesComplianceListResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|
Returns compliance information about entities matching the filter Compliance.FilterSpec. Entities without storage policy association are not returned.
23 24 25 26 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_compliance_api.rb', line 23 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(VcenterStoragePoliciesComplianceListResult|VapiStdErrorsInvalidArgumentError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns compliance information about entities matching the filter Compliance.FilterSpec. Entities without storage policy association are not returned.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/vsphere-automation-vcenter/api/storage_policies_compliance_api.rb', line 33 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: StoragePoliciesComplianceApi.list ...' end if @api_client.config.client_side_validation && opts[:'filter_status'] && !opts[:'filter_status'].all? { |item| ['COMPLIANT', 'NON_COMPLIANT', 'UNKNOWN', 'NOT_APPLICABLE', 'OUT_OF_DATE'].include?(item) } fail ArgumentError, 'invalid value for "filter_status", must include one of COMPLIANT, NON_COMPLIANT, UNKNOWN, NOT_APPLICABLE, OUT_OF_DATE' end # resource path local_var_path = '/vcenter/storage/policies/entities/compliance' # query parameters query_params = {} query_params[:'filter.status'] = @api_client.build_collection_param(opts[:'filter_status'], :multi) if !opts[:'filter_status'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'VCenter::VcenterStoragePoliciesComplianceListResult', '400' => 'VCenter::VapiStdErrorsInvalidArgumentError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: StoragePoliciesComplianceApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |