Class: Google::Cloud::AppEngine::V1::Firewall::Rest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/app_engine/v1/firewall/rest/client.rb

Overview

REST client for the Firewall service.

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.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Firewall REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Firewall client.

Yield Parameters:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 130

def initialize
  # 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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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

  @firewall_stub = ::Google::Cloud::AppEngine::V1::Firewall::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Firewall Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Firewall clients
::Google::Cloud::AppEngine::V1::Firewall::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 68

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

Instance Method Details

#batch_update_ingress_rules(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse #batch_update_ingress_rules(name: nil, ingress_rules: nil) ⇒ ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest.new

# Call the batch_update_ingress_rules method.
result = client.batch_update_ingress_rules request

# The returned object is of type Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse.
p result

Overloads:

  • #batch_update_ingress_rules(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse

    Pass arguments to batch_update_ingress_rules via a request object, either of type BatchUpdateIngressRulesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #batch_update_ingress_rules(name: nil, ingress_rules: nil) ⇒ ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse

    Pass arguments to batch_update_ingress_rules 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.

    • ingress_rules (::Array<::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash>) (defaults to: nil) —

      A list of FirewallRules to replace the existing set.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 305

def batch_update_ingress_rules request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest

  # 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
  call_metadata = @config.rpcs.batch_update_ingress_rules.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_ingress_rules.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_update_ingress_rules.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.batch_update_ingress_rules request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the Firewall 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



100
101
102
103
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#create_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule #create_ingress_rule(parent: nil, rule: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

Creates a firewall rule for the application.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::CreateIngressRuleRequest.new

# Call the create_ingress_rule method.
result = client.create_ingress_rule request

# The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
p result

Overloads:

  • #create_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to create_ingress_rule via a request object, either of type CreateIngressRuleRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::CreateIngressRuleRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_ingress_rule(parent: nil, rule: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to create_ingress_rule 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.

    • rule (::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash) (defaults to: nil) —

      A FirewallRule containing the new resource.

      The user may optionally provide a position at which the new rule will be placed. The positions define a sequential list starting at 1. If a rule already exists at the given position, rules greater than the provided position will be moved forward by one.

      If no position is provided, the server will place the rule as the second to last rule in the sequence before the required default allow-all or deny-all rule.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 395

def create_ingress_rule request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::CreateIngressRuleRequest

  # 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
  call_metadata = @config.rpcs.create_ingress_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_ingress_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_ingress_rule.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.create_ingress_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_ingress_rule(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_ingress_rule(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes the specified firewall rule.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest.new

# Call the delete_ingress_rule method.
result = client.delete_ingress_rule request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_ingress_rule(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_ingress_rule via a request object, either of type DeleteIngressRuleRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_ingress_rule(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_ingress_rule 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 636

def delete_ingress_rule request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest

  # 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
  call_metadata = @config.rpcs.delete_ingress_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_ingress_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_ingress_rule.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.delete_ingress_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule #get_ingress_rule(name: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

Gets the specified firewall rule.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::GetIngressRuleRequest.new

# Call the get_ingress_rule method.
result = client.get_ingress_rule request

# The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
p result

Overloads:

  • #get_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to get_ingress_rule via a request object, either of type GetIngressRuleRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::GetIngressRuleRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_ingress_rule(name: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to get_ingress_rule 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 474

def get_ingress_rule request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::GetIngressRuleRequest

  # 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
  call_metadata = @config.rpcs.get_ingress_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_ingress_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_ingress_rule.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.get_ingress_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_ingress_rules(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule> #list_ingress_rules(parent: nil, page_size: nil, page_token: nil, matching_address: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule>

Lists the firewall rules of an application.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::ListIngressRulesRequest.new

# Call the list_ingress_rules method.
result = client.list_ingress_rules request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AppEngine::V1::FirewallRule.
  p item
end

Overloads:

  • #list_ingress_rules(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule>

    Pass arguments to list_ingress_rules via a request object, either of type ListIngressRulesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::ListIngressRulesRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_ingress_rules(parent: nil, page_size: nil, page_token: nil, matching_address: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule>

    Pass arguments to list_ingress_rules 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.

    • page_size (::Integer) (defaults to: nil) —

      Maximum results to return per page.

    • page_token (::String) (defaults to: nil) —

      Continuation token for fetching the next page of results.

    • matching_address (::String) (defaults to: nil) —

      A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 219

def list_ingress_rules request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::ListIngressRulesRequest

  # 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
  call_metadata = @config.rpcs.list_ingress_rules.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_ingress_rules.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_ingress_rules.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.list_ingress_rules request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @firewall_stub, :list_ingress_rules, "ingress_rules", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 110

def universe_domain
  @firewall_stub.universe_domain
end

#update_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule #update_ingress_rule(name: nil, rule: nil, update_mask: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

Updates the specified firewall rule.

Examples:

Basic example

require "google/cloud/app_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AppEngine::V1::Firewall::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest.new

# Call the update_ingress_rule method.
result = client.update_ingress_rule request

# The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
p result

Overloads:

  • #update_ingress_rule(request, options = nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to update_ingress_rule via a request object, either of type UpdateIngressRuleRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_ingress_rule(name: nil, rule: nil, update_mask: nil) ⇒ ::Google::Cloud::AppEngine::V1::FirewallRule

    Pass arguments to update_ingress_rule 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.

    • rule (::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash) (defaults to: nil) —

      A FirewallRule containing the updated resource

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Standard field mask for the set of fields to be updated.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/google/cloud/app_engine/v1/firewall/rest/client.rb', line 557

def update_ingress_rule request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest

  # 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
  call_metadata = @config.rpcs.update_ingress_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_ingress_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_ingress_rule.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @firewall_stub.update_ingress_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end