App Engine Admin API - Module Google::Cloud::AppEngine (v1.5.0)

Reference documentation and code samples for the App Engine Admin API module Google::Cloud::AppEngine.

Methods

.applications

def self.applications(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Applications.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Applications::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Applications service. You can determine whether the method will succeed by calling AppEngine.applications_available?.

About Applications

Manages App Engine applications.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.applications_available?

def self.applications_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Applications service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.applications. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Applications service, or if the versioned client gem needs an update to support the Applications service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.authorized_certificates

def self.authorized_certificates(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for AuthorizedCertificates.

By default, this returns an instance of Google::Cloud::AppEngine::V1::AuthorizedCertificates::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AuthorizedCertificates service. You can determine whether the method will succeed by calling AppEngine.authorized_certificates_available?.

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.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.authorized_certificates_available?

def self.authorized_certificates_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the AuthorizedCertificates service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.authorized_certificates. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AuthorizedCertificates service, or if the versioned client gem needs an update to support the AuthorizedCertificates service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.authorized_domains

def self.authorized_domains(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for AuthorizedDomains.

By default, this returns an instance of Google::Cloud::AppEngine::V1::AuthorizedDomains::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AuthorizedDomains service. You can determine whether the method will succeed by calling AppEngine.authorized_domains_available?.

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.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.authorized_domains_available?

def self.authorized_domains_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the AuthorizedDomains service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.authorized_domains. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AuthorizedDomains service, or if the versioned client gem needs an update to support the AuthorizedDomains service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::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 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
  • (::Google::Cloud.configure.app_engine)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.domain_mappings

def self.domain_mappings(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DomainMappings.

By default, this returns an instance of Google::Cloud::AppEngine::V1::DomainMappings::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DomainMappings service. You can determine whether the method will succeed by calling AppEngine.domain_mappings_available?.

About DomainMappings

Manages domains serving an application.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.domain_mappings_available?

def self.domain_mappings_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DomainMappings service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.domain_mappings. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DomainMappings service, or if the versioned client gem needs an update to support the DomainMappings service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.firewall

def self.firewall(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Firewall.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Firewall::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Firewall service. You can determine whether the method will succeed by calling AppEngine.firewall_available?.

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.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.firewall_available?

def self.firewall_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Firewall service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.firewall. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Firewall service, or if the versioned client gem needs an update to support the Firewall service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.instances

def self.instances(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Instances.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Instances::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Instances service. You can determine whether the method will succeed by calling AppEngine.instances_available?.

About Instances

Manages instances of a version.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.instances_available?

def self.instances_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Instances service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.instances. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Instances service, or if the versioned client gem needs an update to support the Instances service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.services

def self.services(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Services.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Services::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Services service. You can determine whether the method will succeed by calling AppEngine.services_available?.

About Services

Manages services of an application.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.services_available?

def self.services_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Services service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.services. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Services service, or if the versioned client gem needs an update to support the Services service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.versions

def self.versions(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for Versions.

By default, this returns an instance of Google::Cloud::AppEngine::V1::Versions::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Versions service. You can determine whether the method will succeed by calling AppEngine.versions_available?.

About Versions

Manages versions of a service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.versions_available?

def self.versions_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the Versions service is supported by the current client. If true, you can retrieve a client object by calling AppEngine.versions. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Versions service, or if the versioned client gem needs an update to support the Versions service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.5.0"