Class: VSphereAutomation::VAPI::MetadataPrivilegeServiceOperationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetadataPrivilegeServiceOperationApi

Returns a new instance of MetadataPrivilegeServiceOperationApi.



16
17
18
 
# File 'lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_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-vapi/api/metadata_privilege_service_operation_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get(service_id, action, request_body, opts = {}) ⇒ VapiMetadataPrivilegeServiceOperationResult|VapiStdErrorsNotFoundError|

Retrieves the privilege information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

Parameters:

  • service_id —

    Identifier of the service element.

  • action —

    ~action=get

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_api.rb', line 25

def get(service_id, action, request_body, opts = {})
  data, _status_code, _headers = get_with_http_info(service_id, action, request_body, opts)
  data
end

#get_with_http_info(service_id, action, request_body, opts = {}) ⇒ Array<(VapiMetadataPrivilegeServiceOperationResult|VapiStdErrorsNotFoundError|, 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.

Retrieves the privilege information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.

Parameters:

  • service_id —

    Identifier of the service element.

  • action —

    ~action&#x3D;get

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_api.rb', line 37

def get_with_http_info(service_id, action, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataPrivilegeServiceOperationApi.get ...'
  end
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling MetadataPrivilegeServiceOperationApi.get"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling MetadataPrivilegeServiceOperationApi.get"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['get'].include?(action)
    fail ArgumentError, "invalid value for 'action', must be one of get"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling MetadataPrivilegeServiceOperationApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/privilege/service/operation/id:{service_id}'.sub('{' + 'service_id' + '}', service_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'~action'] = action

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, 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' => 'VAPI::VapiMetadataPrivilegeServiceOperationResult',
	  '404' => 'VAPI::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataPrivilegeServiceOperationApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(service_id, opts = {}) ⇒ VapiMetadataPrivilegeServiceOperationListResult|VapiStdErrorsNotFoundError|

Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have privilege information.

Parameters:

  • service_id —

    Identifier of the service element.

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_api.rb', line 96

def list(service_id, opts = {})
  data, _status_code, _headers = list_with_http_info(service_id, opts)
  data
end

#list_with_http_info(service_id, opts = {}) ⇒ Array<(VapiMetadataPrivilegeServiceOperationListResult|VapiStdErrorsNotFoundError|, 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 the identifiers for the operation elements contained in the service element corresponding to serviceId that have privilege information.

Parameters:

  • service_id —

    Identifier of the service element.

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

    the optional parameters

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/vsphere-automation-vapi/api/metadata_privilege_service_operation_api.rb', line 106

def list_with_http_info(service_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataPrivilegeServiceOperationApi.list ...'
  end
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling MetadataPrivilegeServiceOperationApi.list"
  end
  # resource path
  local_var_path = '/com/vmware/vapi/metadata/privilege/service/operation'

  # query parameters
  query_params = {}
  query_params[:'service_id'] = service_id

  # 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' => 'VAPI::VapiMetadataPrivilegeServiceOperationListResult',
	  '404' => 'VAPI::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetadataPrivilegeServiceOperationApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end