Module: Google::Cloud::AppEngine

Defined in:
lib/google/cloud/app_engine.rb,
lib/google/cloud/app_engine/version.rb

Constant Summary collapse

VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.applications(version: :v1, &block) ⇒ Applications::Client

Create a new client object for Applications.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Applications::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Applications service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Applications

Manages App Engine applications.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Applications::Client) —

    A client object for the specified version.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/google/cloud/app_engine.rb', line 66

def self.applications version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:Applications).const_get(:Client).new(&block)
end

.authorized_certificates(version: :v1, &block) ⇒ AuthorizedCertificates::Client

Create a new client object for AuthorizedCertificates.

By default, this returns an instance of Google::Cloud::AppEngine::V1::AuthorizedCertificates::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the AuthorizedCertificates service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AuthorizedCertificates

Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (AuthorizedCertificates::Client) —

    A client object for the specified version.



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/google/cloud/app_engine.rb', line 258

def self.authorized_certificates version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:AuthorizedCertificates).const_get(:Client).new(&block)
end

.authorized_domains(version: :v1, &block) ⇒ AuthorizedDomains::Client

Create a new client object for AuthorizedDomains.

By default, this returns an instance of Google::Cloud::AppEngine::V1::AuthorizedDomains::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the AuthorizedDomains service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AuthorizedDomains

Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (AuthorizedDomains::Client) —

    A client object for the specified version.



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/google/cloud/app_engine.rb', line 227

def self.authorized_domains version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:AuthorizedDomains).const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.app_engine| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-app_engine library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



327
328
329
330
331
 
# File 'lib/google/cloud/app_engine.rb', line 327

def self.configure
  yield ::Google::Cloud.configure.app_engine if block_given?

  ::Google::Cloud.configure.app_engine
end

.domain_mappings(version: :v1, &block) ⇒ DomainMappings::Client

Create a new client object for DomainMappings.

By default, this returns an instance of Google::Cloud::AppEngine::V1::DomainMappings::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the DomainMappings service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About DomainMappings

Manages domains serving an application.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (DomainMappings::Client) —

    A client object for the specified version.



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/google/cloud/app_engine.rb', line 288

def self.domain_mappings version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:DomainMappings).const_get(:Client).new(&block)
end

.firewall(version: :v1, &block) ⇒ Firewall::Client

Create a new client object for Firewall.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Firewall::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Firewall service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Firewall

Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.

Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Firewall::Client) —

    A client object for the specified version.



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/google/cloud/app_engine.rb', line 195

def self.firewall version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:Firewall).const_get(:Client).new(&block)
end

.instances(version: :v1, &block) ⇒ Instances::Client

Create a new client object for Instances.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Instances::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Instances service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Instances

Manages instances of a version.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Instances::Client) —

    A client object for the specified version.



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/cloud/app_engine.rb', line 156

def self.instances version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:Instances).const_get(:Client).new(&block)
end

.services(version: :v1, &block) ⇒ Services::Client

Create a new client object for Services.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Services::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Services service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Services

Manages services of an application.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Services::Client) —

    A client object for the specified version.



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/google/cloud/app_engine.rb', line 96

def self.services version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:Services).const_get(:Client).new(&block)
end

.versions(version: :v1, &block) ⇒ Versions::Client

Create a new client object for Versions.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Versions::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Versions service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Versions

Manages versions of a service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Versions::Client) —

    A client object for the specified version.



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/google/cloud/app_engine.rb', line 126

def self.versions version: :v1, &block
  require "google/cloud/app_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::AppEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::AppEngine.const_get package_name
  package_module.const_get(:Versions).const_get(:Client).new(&block)
end