class Google::Cloud::AppEngine::V1::Applications::Client
Client
for the Applications
service.
Manages App Engine applications.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::AppEngine::V1::Applications::Operations]
Public Class Methods
Configure the Applications
Client
class.
See {::Google::Cloud::AppEngine::V1::Applications::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Applications clients ::Google::Cloud::AppEngine::V1::Applications::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 54 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "AppEngine", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end
Create a new Applications
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::AppEngine::V1::Applications::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AppEngine::V1::Applications::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Applications
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 107 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/appengine/v1/appengine_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @applications_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::AppEngine::V1::Applications::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the Applications
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::AppEngine::V1::Applications::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 86 def configure yield @config if block_given? @config end
Creates an App Engine application for a Google
Cloud
Platform project. Required fields:
-
`id` - The ID of the target
Cloud
Platform project. -
location - The [region](cloud.google.com/appengine/docs/locations) where you want the App Engine application located.
For more information about App Engine applications, see [Managing Projects, Applications
, and Billing](cloud.google.com/appengine/docs/standard/python/console/).
@overload create_application
(request, options = nil)
Pass arguments to `create_application` via a request object, either of type {::Google::Cloud::AppEngine::V1::CreateApplicationRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::CreateApplicationRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_application
(application: nil)
Pass arguments to `create_application` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param application [::Google::Cloud::AppEngine::V1::Application, ::Hash] Application configuration.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 260 def create_application request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::CreateApplicationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_application.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AppEngine::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.create_application.timeout, metadata: metadata, retry_policy: @config.rpcs.create_application.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @applications_stub.call_rpc :create_application, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets information about an application.
@overload get_application
(request, options = nil)
Pass arguments to `get_application` via a request object, either of type {::Google::Cloud::AppEngine::V1::GetApplicationRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::GetApplicationRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_application
(name: nil)
Pass arguments to `get_application` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Name of the Application resource to get. Example: `apps/myapp`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::AppEngine::V1::Application] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::AppEngine::V1::Application]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 186 def get_application request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::GetApplicationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_application.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AppEngine::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_application.timeout, metadata: metadata, retry_policy: @config.rpcs.get_application.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @applications_stub.call_rpc :get_application, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Recreates the required App Engine features for the specified App Engine application, for example a Cloud
Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, *Error retrieving the App Engine service account*. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B“name”%3A“projects%2F-%2FserviceAccounts%2Funique_id”%2C“resource”%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud
Console Activity Log.
@overload repair_application
(request, options = nil)
Pass arguments to `repair_application` via a request object, either of type {::Google::Cloud::AppEngine::V1::RepairApplicationRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::RepairApplicationRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload repair_application
(name: nil)
Pass arguments to `repair_application` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Name of the application to repair. Example: `apps/myapp`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 409 def repair_application request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::RepairApplicationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.repair_application.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AppEngine::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.repair_application.timeout, metadata: metadata, retry_policy: @config.rpcs.repair_application.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @applications_stub.call_rpc :repair_application, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the specified Application
resource. You can update the following fields:
-
`auth_domain` -
Google
authentication domain for controlling user access to the application. -
`default_cookie_expiration` - Cookie expiration policy for the application.
@overload update_application
(request, options = nil)
Pass arguments to `update_application` via a request object, either of type {::Google::Cloud::AppEngine::V1::UpdateApplicationRequest} or an equivalent Hash. @param request [::Google::Cloud::AppEngine::V1::UpdateApplicationRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_application
(name: nil, application: nil, update_mask: nil)
Pass arguments to `update_application` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Name of the Application resource to update. Example: `apps/myapp`. @param application [::Google::Cloud::AppEngine::V1::Application, ::Hash] An Application containing the updated resource. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Standard field mask for the set of fields to be updated.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/app_engine/v1/applications/client.rb, line 331 def update_application request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::UpdateApplicationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_application.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::AppEngine::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_application.timeout, metadata: metadata, retry_policy: @config.rpcs.update_application.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @applications_stub.call_rpc :update_application, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end