class Google::Apis::AppstateV1::AppStateService
Google App State API
The Google App State API.
@example
require 'google/apis/appstate_v1' Appstate = Google::Apis::AppstateV1 # Alias the module service = Appstate::AppStateService.new
Attributes
@return [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.
@return [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. Overrides userIp if both are provided.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/appstate_v1/service.rb, line 51 def initialize super('https://www.googleapis.com/', 'appstate/v1/') end
Public Instance Methods
Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch. @param [Fixnum] state_key
The key for the data to be retrieved.
@param [String] current_data_version
The version of the data to be cleared. Version strings are returned by the server.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AppstateV1::WriteResult] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AppstateV1::WriteResult]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/appstate_v1/service.rb, line 84 def clear_state(state_key, current_data_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'states/{stateKey}/clear', options) command.response_representation = Google::Apis::AppstateV1::WriteResult::Representation command.response_class = Google::Apis::AppstateV1::WriteResult command.params['stateKey'] = state_key unless state_key.nil? command.query['currentDataVersion'] = current_data_version unless current_data_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption. @param [Fixnum] state_key
The key for the data to be retrieved.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/appstate_v1/service.rb, line 124 def delete_state(state_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'states/{stateKey}', options) command.params['stateKey'] = state_key unless state_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned. @param [Fixnum] state_key
The key for the data to be retrieved.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AppstateV1::GetResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AppstateV1::GetResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/appstate_v1/service.rb, line 158 def get_state(state_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'states/{stateKey}', options) command.response_representation = Google::Apis::AppstateV1::GetResponse::Representation command.response_class = Google::Apis::AppstateV1::GetResponse command.params['stateKey'] = state_key unless state_key.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Lists all the states keys, and optionally the state data. @param [Boolean] include_data
Whether to include the full data in addition to the version number
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AppstateV1::ListResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AppstateV1::ListResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/appstate_v1/service.rb, line 193 def list_states(include_data: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'states', options) command.response_representation = Google::Apis::AppstateV1::ListResponse::Representation command.response_class = Google::Apis::AppstateV1::ListResponse command.query['includeData'] = include_data unless include_data.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB. @param [Fixnum] state_key
The key for the data to be retrieved.
@param [Google::Apis::AppstateV1::UpdateRequest] update_request_object @param [String] current_state_version
The version of the app state your application is attempting to update. If this does not match the current version, this method will return a conflict error. If there is no data stored on the server for this key, the update will succeed irrespective of the value of this parameter.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
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. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AppstateV1::WriteResult] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::AppstateV1::WriteResult]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/appstate_v1/service.rb, line 236 def update_state(state_key, update_request_object = nil, current_state_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'states/{stateKey}', options) command.request_representation = Google::Apis::AppstateV1::UpdateRequest::Representation command.request_object = update_request_object command.response_representation = Google::Apis::AppstateV1::WriteResult::Representation command.response_class = Google::Apis::AppstateV1::WriteResult command.params['stateKey'] = state_key unless state_key.nil? command.query['currentStateVersion'] = current_state_version unless current_state_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File generated/google/apis/appstate_v1/service.rb, line 252 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end