Class: Google::Apis::FirebaseremoteconfigV1::FirebaseRemoteConfigService

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

Overview

Firebase Remote Config API

Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.

Examples:

require 'google/apis/firebaseremoteconfig_v1'

Firebaseremoteconfig = Google::Apis::FirebaseremoteconfigV1 # Alias the module
service = Firebaseremoteconfig::FirebaseRemoteConfigService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ FirebaseRemoteConfigService

Returns a new instance of FirebaseRemoteConfigService



46
47
48
49
 
# File 'generated/google/apis/firebaseremoteconfig_v1/service.rb', line 46

def initialize
  super('https://firebaseremoteconfig.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.



39
40
41
 
# File 'generated/google/apis/firebaseremoteconfig_v1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/firebaseremoteconfig_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#get_project_remote_config(project, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseremoteconfigV1::RemoteConfig

Get the latest version Remote Configuration for a project. Returns the RemoteConfig as the payload, and also the eTag as a response header.

Parameters:

  • project (String) —

    The GMP project identifier. Required. See note at the beginning of this file regarding project ids.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



74
75
76
77
78
79
80
81
82
 
# File 'generated/google/apis/firebaseremoteconfig_v1/service.rb', line 74

def get_project_remote_config(project, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+project}/remoteConfig', options)
  command.response_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation
  command.response_class = Google::Apis::FirebaseremoteconfigV1::RemoteConfig
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_remote_config(project, remote_config_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseremoteconfigV1::RemoteConfig

Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages:

  • VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated.
  • AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token).
  • AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id).
  • VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag.
  • Internal error (HTTP status 500) for Database problems or other internal errors.

Parameters:

  • project (String) —

    The GMP project identifier. Required. See note at the beginning of this file regarding project ids.

  • remote_config_object (Google::Apis::FirebaseremoteconfigV1::RemoteConfig) (defaults to: nil)
  • validate_only (Boolean) —

    Optional. Defaults to false (UpdateRemoteConfig call should update the backend if there are no validation/interal errors). May be set to true to indicate that, should no validation errors occur, the call should return a "200 OK" instead of performing the update. Note that other error messages (500 Internal Error, 412 Version Mismatch, etc) may still result after flipping to false, even if getting a "200 OK" when calling with true.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'generated/google/apis/firebaseremoteconfig_v1/service.rb', line 131

def update_project_remote_config(project, remote_config_object = nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/{+project}/remoteConfig', options)
  command.request_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation
  command.request_object = remote_config_object
  command.response_representation = Google::Apis::FirebaseremoteconfigV1::RemoteConfig::Representation
  command.response_class = Google::Apis::FirebaseremoteconfigV1::RemoteConfig
  command.params['project'] = project unless project.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end