Class: AsposeCellsCloud::GetPivotTableFieldRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetPivotTableFieldRequest

Returns a new instance of GetPivotTableFieldRequest.



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
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 42

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'name')
      self.name = attributes[:'name']
  end
  if attributes.has_key?(:'sheetName')
      self.sheet_name = attributes[:'sheetName']
  end
  if attributes.has_key?(:'pivotTableIndex')
      self.pivot_table_index = attributes[:'pivotTableIndex']
  end
  if attributes.has_key?(:'pivotFieldIndex')
      self.pivot_field_index = attributes[:'pivotFieldIndex']
  end
  if attributes.has_key?(:'pivotFieldType')
      self.pivot_field_type = attributes[:'pivotFieldType']
  end
  if attributes.has_key?(:'folder')
      self.folder = attributes[:'folder']
  end
  if attributes.has_key?(:'storageName')
      self.storage_name = attributes[:'storageName']
  end

end

Instance Attribute Details

#folder ⇒ Object

Returns the value of attribute folder.



39
40
41
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 39

def folder
  @folder
end

#name ⇒ Object

Returns the value of attribute name.



34
35
36
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 34

def name
  @name
end

#pivot_field_index ⇒ Object

Returns the value of attribute pivot_field_index.



37
38
39
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 37

def pivot_field_index
  @pivot_field_index
end

#pivot_field_type ⇒ Object

Returns the value of attribute pivot_field_type.



38
39
40
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 38

def pivot_field_type
  @pivot_field_type
end

#pivot_table_index ⇒ Object

Returns the value of attribute pivot_table_index.



36
37
38
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 36

def pivot_table_index
  @pivot_table_index
end

#sheet_name ⇒ Object

Returns the value of attribute sheet_name.



35
36
37
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 35

def sheet_name
  @sheet_name
end

#storage_name ⇒ Object

Returns the value of attribute storage_name.



40
41
42
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 40

def storage_name
  @storage_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 72

def self.attribute_map
  {
    :'name' => :'name',
    :'sheet_name' => :'sheetName',
    :'pivot_table_index' => :'pivotTableIndex',
    :'pivot_field_index' => :'pivotFieldIndex',
    :'pivot_field_type' => :'pivotFieldType',
    :'folder' => :'folder',
    :'storage_name' => :'storageName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 85

def self.swagger_types
  {
    :'name' => :'String',
    :'sheet_name' => :'String',
    :'pivot_table_index' => :'Integer',
    :'pivot_field_index' => :'Integer',
    :'pivot_field_type' => :'String',
    :'folder' => :'String',
    :'storage_name' => :'String'
  }
end

Instance Method Details

#create_http_request(api_client, opts = {}) ⇒ Object 



97
98
99
100
101
102
103
104
105
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
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aspose_cells_cloud/requests/get_pivot_table_field_request.rb', line 97

def create_http_request(api_client,opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug "Calling API: CellsApi.get_pivot_table_field ..."
  end
  api_client.request_token_if_needed
  # verify the required parameter 'name' is set
  if api_client.config.client_side_validation && name.nil?
      fail ArgumentError, "Missing the required parameter 'name' when calling CellsApi.get_pivot_table_field "
  end 
  # verify the required parameter 'sheet_name' is set
  if api_client.config.client_side_validation && sheet_name.nil?
      fail ArgumentError, "Missing the required parameter 'sheet_name' when calling CellsApi.get_pivot_table_field "
  end 
  # verify the required parameter 'pivot_table_index' is set
  if api_client.config.client_side_validation && pivot_table_index.nil?
      fail ArgumentError, "Missing the required parameter 'pivot_table_index' when calling CellsApi.get_pivot_table_field "
  end 
  # verify the required parameter 'pivot_field_index' is set
  if api_client.config.client_side_validation && pivot_field_index.nil?
      fail ArgumentError, "Missing the required parameter 'pivot_field_index' when calling CellsApi.get_pivot_table_field "
  end 
  # verify the required parameter 'pivot_field_type' is set
  if api_client.config.client_side_validation && pivot_field_type.nil?
      fail ArgumentError, "Missing the required parameter 'pivot_field_type' when calling CellsApi.get_pivot_table_field "
  end 

  # resource path
  local_var_path = "/cells/{name}/worksheets/{sheetName}/pivottables/{pivotTableIndex}/PivotField".sub('{' + 'name' + '}', name.to_s).sub('{' + 'sheetName' + '}', sheet_name.to_s).sub('{' + 'pivotTableIndex' + '}', pivot_table_index.to_s)
  # query parameters
  query_params = {}
  query_params[:'pivotFieldIndex'] = self.pivot_field_index if !self.pivot_field_index.nil? 
  query_params[:'pivotFieldType'] = self.pivot_field_type if !self.pivot_field_type.nil? 
  query_params[:'folder'] = self.folder if !self.folder.nil? 
  query_params[:'storageName'] = self.storage_name if !self.storage_name.nil? 

  # 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 = {}
  post_body = nil 
     

  #auth_names = []
  auth_names = ['JWT']
  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 => 'PivotFieldResponse')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Specification.Name>Api.get_pivot_table_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end