Class: Google::Apis::Area120tablesV1alpha1::Area120TablesService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/area120tables_v1alpha1/service.rb

Overview

Area120 Tables API

Examples:

require 'google/apis/area120tables_v1alpha1'

Area120tables = Google::Apis::Area120tablesV1alpha1 # Alias the module
service = Area120tables::Area120TablesService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Area120TablesService

Returns a new instance of Area120TablesService.



45
46
47
48
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 45

def initialize
  super('https://area120tables.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_create_rows(parent, batch_create_rows_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::BatchCreateRowsResponse

Creates multiple rows.

Parameters:

  • parent (String) —

    Required. The parent table where the rows will be created. Format: tables/ table

  • batch_create_rows_request_object (Google::Apis::Area120tablesV1alpha1::BatchCreateRowsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



139
140
141
142
143
144
145
146
147
148
149
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 139

def batch_create_rows(parent, batch_create_rows_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/rows:batchCreate', options)
  command.request_representation = Google::Apis::Area120tablesV1alpha1::BatchCreateRowsRequest::Representation
  command.request_object = batch_create_rows_request_object
  command.response_representation = Google::Apis::Area120tablesV1alpha1::BatchCreateRowsResponse::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::BatchCreateRowsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_update_rows(parent, batch_update_rows_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::BatchUpdateRowsResponse

Updates multiple rows.

Parameters:

  • parent (String) —

    Required. The parent table shared by all rows being updated. Format: tables/ table

  • batch_update_rows_request_object (Google::Apis::Area120tablesV1alpha1::BatchUpdateRowsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



173
174
175
176
177
178
179
180
181
182
183
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 173

def batch_update_rows(parent, batch_update_rows_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/rows:batchUpdate', options)
  command.request_representation = Google::Apis::Area120tablesV1alpha1::BatchUpdateRowsRequest::Representation
  command.request_object = batch_update_rows_request_object
  command.response_representation = Google::Apis::Area120tablesV1alpha1::BatchUpdateRowsResponse::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::BatchUpdateRowsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_table_row(parent, row_object = nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Row

Creates a row.

Parameters:

  • parent (String) —

    Required. The parent table where this row will be created. Format: tables/ table

  • row_object (Google::Apis::Area120tablesV1alpha1::Row) (defaults to: nil)
  • view (String) (defaults to: nil) —

    Optional. Column key to use for values in the row. Defaults to user entered name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 210

def create_table_row(parent, row_object = nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/rows', options)
  command.request_representation = Google::Apis::Area120tablesV1alpha1::Row::Representation
  command.request_object = row_object
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Row::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Row
  command.params['parent'] = parent unless parent.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_table_row(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Empty

Deletes a row.

Parameters:

  • name (String) —

    Required. The name of the row to delete. Format: tables/table/rows/row

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



243
244
245
246
247
248
249
250
251
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 243

def delete_table_row(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Empty::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_table(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Table

Gets a table. Returns NOT_FOUND if the table does not exist.

Parameters:

  • name (String) —

    Required. The name of the table to retrieve. Format: tables/table

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



70
71
72
73
74
75
76
77
78
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 70

def get_table(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Table::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Table
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_table_row(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Row

Gets a row. Returns NOT_FOUND if the row does not exist in the table.

Parameters:

  • name (String) —

    Required. The name of the row to retrieve. Format: tables/table/rows/row

  • view (String) (defaults to: nil) —

    Optional. Column key to use for values in the row. Defaults to user entered name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



276
277
278
279
280
281
282
283
284
285
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 276

def get_table_row(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Row::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Row
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_workspace(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Workspace

Gets a workspace. Returns NOT_FOUND if the workspace does not exist.

Parameters:

  • name (String) —

    Required. The name of the workspace to retrieve. Format: workspaces/workspace

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



392
393
394
395
396
397
398
399
400
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 392

def get_workspace(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Workspace::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Workspace
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_table_rows(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::ListRowsResponse

Lists rows in a table. Returns NOT_FOUND if the table does not exist.

Parameters:

  • parent (String) —

    Required. The parent table. Format: tables/table

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1, 000; values above 1,000 are coerced to 1,000.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRows must match the call that provided the page token.

  • view (String) (defaults to: nil) —

    Optional. Column key to use for values in the row. Defaults to user entered name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 318

def list_table_rows(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/rows', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::ListRowsResponse::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::ListRowsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_tables(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::ListTablesResponse

Lists tables for the user.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTables must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



106
107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 106

def list_tables(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/tables', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::ListTablesResponse::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::ListTablesResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_workspaces(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::ListWorkspacesResponse

Lists workspaces for the user.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

  • page_token (String) (defaults to: nil) —

    A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



428
429
430
431
432
433
434
435
436
437
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 428

def list_workspaces(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/workspaces', options)
  command.response_representation = Google::Apis::Area120tablesV1alpha1::ListWorkspacesResponse::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::ListWorkspacesResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_table_row(name, row_object = nil, update_mask: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Area120tablesV1alpha1::Row

Updates a row.

Parameters:

  • name (String) —

    The resource name of the row. Row names have the form tables/table/rows/ row``. The name is ignored when creating a row.

  • row_object (Google::Apis::Area120tablesV1alpha1::Row) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to update.

  • view (String) (defaults to: nil) —

    Optional. Column key to use for values in the row. Defaults to user entered name.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'generated/google/apis/area120tables_v1alpha1/service.rb', line 358

def patch_table_row(name, row_object = nil, update_mask: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::Area120tablesV1alpha1::Row::Representation
  command.request_object = row_object
  command.response_representation = Google::Apis::Area120tablesV1alpha1::Row::Representation
  command.response_class = Google::Apis::Area120tablesV1alpha1::Row
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end