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

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

Overview

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 client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the Firewall client.

Yield Parameters:



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
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 131

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.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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AppEngine::V1::Firewall::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
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::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 324

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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.batch_update_ingress_rules.timeout,
                         metadata:     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.call_rpc :batch_update_ingress_rules, 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

#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:



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

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 422

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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.create_ingress_rule.timeout,
                         metadata:     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.call_rpc :create_ingress_rule, 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

#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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 687

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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.delete_ingress_rule.timeout,
                         metadata:     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.call_rpc :delete_ingress_rule, 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

#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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 509

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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_ingress_rule.timeout,
                         metadata:     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.call_rpc :get_ingress_rule, 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

#list_ingress_rules(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule> #list_ingress_rules(parent: nil, page_size: nil, page_token: nil, matching_address: nil) ⇒ ::Gapic::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::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::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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 230

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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.list_ingress_rules.timeout,
                         metadata:     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.call_rpc :list_ingress_rules, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @firewall_stub, :list_ingress_rules, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


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

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::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/google/cloud/app_engine/v1/firewall/client.rb', line 600

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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_ingress_rule.timeout,
                         metadata:     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.call_rpc :update_ingress_rule, 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