Class: Google::Cloud::Compute::V1::NetworkFirewallPolicies::Rest::Client

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

Overview

REST client for the NetworkFirewallPolicies service.

The NetworkFirewallPolicies API.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new NetworkFirewallPolicies REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the NetworkFirewallPolicies client.

Yield Parameters:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 157

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
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @global_operations = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @network_firewall_policies_stub = ::Google::Cloud::Compute::V1::NetworkFirewallPolicies::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Instance Attribute Details

#global_operations ⇒ ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client (readonly)

Get the associated client for long-running operations via GlobalOperations.

Returns:



184
185
186
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 184

def global_operations
  @global_operations
end

Class Method Details

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

Configure the NetworkFirewallPolicies Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Compute", "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.rpcs.add_association.timeout = 600.0

    default_config.rpcs.add_rule.timeout = 600.0

    default_config.rpcs.clone_rules.timeout = 600.0

    default_config.rpcs.delete.timeout = 600.0

    default_config.rpcs.get.timeout = 600.0
    default_config.rpcs.get.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_association.timeout = 600.0
    default_config.rpcs.get_association.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_iam_policy.timeout = 600.0
    default_config.rpcs.get_iam_policy.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_rule.timeout = 600.0
    default_config.rpcs.get_rule.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.insert.timeout = 600.0

    default_config.rpcs.list.timeout = 600.0
    default_config.rpcs.list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.patch.timeout = 600.0

    default_config.rpcs.patch_rule.timeout = 600.0

    default_config.rpcs.remove_association.timeout = 600.0

    default_config.rpcs.remove_rule.timeout = 600.0

    default_config.rpcs.set_iam_policy.timeout = 600.0

    default_config.rpcs.test_iam_permissions.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#add_association(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #add_association(firewall_policy: nil, firewall_policy_association_resource: nil, project: nil, replace_existing_association: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Inserts an association for the specified firewall policy.

Overloads:

  • #add_association(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::AddAssociationNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #add_association(firewall_policy: nil, firewall_policy_association_resource: nil, project: nil, replace_existing_association: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to add_association 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:

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

      Name of the firewall policy to update.

    • firewall_policy_association_resource (::Google::Cloud::Compute::V1::FirewallPolicyAssociation, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Project ID for this request.

    • replace_existing_association (::Boolean) (defaults to: nil) —

      Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



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
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 225

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddAssociationNetworkFirewallPolicyRequest

  # 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.add_association.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.add_association.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.add_association request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#add_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #add_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, max_priority: nil, min_priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Inserts a rule into a firewall policy.

Overloads:

  • #add_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::AddRuleNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #add_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, max_priority: nil, min_priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to add_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:

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

      Name of the firewall policy to update.

    • firewall_policy_rule_resource (::Google::Cloud::Compute::V1::FirewallPolicyRule, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

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

      When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



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
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 307

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddRuleNetworkFirewallPolicyRequest

  # 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.add_rule.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.add_rule.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.add_rule request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#clone_rules(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #clone_rules(firewall_policy: nil, project: nil, request_id: nil, source_firewall_policy: nil) ⇒ ::Gapic::GenericLRO::Operation

Copies rules to the specified firewall policy.

Overloads:

  • #clone_rules(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::CloneRulesNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #clone_rules(firewall_policy: nil, project: nil, request_id: nil, source_firewall_policy: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to clone_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:

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

      Name of the firewall policy to update.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

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

      The firewall policy from which to copy rules.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



385
386
387
388
389
390
391
392
393
394
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
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 385

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::CloneRulesNetworkFirewallPolicyRequest

  # 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.clone_rules.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.clone_rules.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.clone_rules request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

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

Configure the NetworkFirewallPolicies 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:



136
137
138
139
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 136

def configure
  yield @config if block_given?
  @config
end

#delete(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #delete(firewall_policy: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Deletes the specified policy.

Overloads:

  • #delete(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::DeleteNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #delete(firewall_policy: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to delete 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:

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

      Name of the firewall policy to delete.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



461
462
463
464
465
466
467
468
469
470
471
472
473
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
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 461

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteNetworkFirewallPolicyRequest

  # 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.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.delete.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.delete request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicy #get(firewall_policy: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicy

Returns the specified network firewall policy.

Overloads:

  • #get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicy

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #get(firewall_policy: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicy

    Pass arguments to get 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:

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

      Name of the firewall policy to get.

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

      Project ID for this request.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 535

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetNetworkFirewallPolicyRequest

  # 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.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.get request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#get_association(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyAssociation #get_association(firewall_policy: nil, name: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyAssociation

Gets an association with the specified name.

Overloads:

  • #get_association(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyAssociation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetAssociationNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #get_association(firewall_policy: nil, name: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyAssociation

    Pass arguments to get_association 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:

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

      Name of the firewall policy to which the queried association belongs.

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

      The name of the association to get from the firewall policy.

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

      Project ID for this request.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 603

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetAssociationNetworkFirewallPolicyRequest

  # 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_association.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get_association.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.get_association request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#get_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy #get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Overloads:

  • #get_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetIamPolicyNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

    Pass arguments to get_iam_policy 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:

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

      Requested IAM Policy version.

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

      Project ID for this request.

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

      Name or id of the resource for this request.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 671

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetIamPolicyNetworkFirewallPolicyRequest

  # 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_iam_policy.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.get_iam_policy request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#get_rule(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyRule #get_rule(firewall_policy: nil, priority: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyRule

Gets a rule of the specified priority.

Overloads:

  • #get_rule(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyRule

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::GetRuleNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #get_rule(firewall_policy: nil, priority: nil, project: nil) ⇒ ::Google::Cloud::Compute::V1::FirewallPolicyRule

    Pass arguments to get_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:

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

      Name of the firewall policy to which the queried rule belongs.

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

      The priority of the rule to get from the firewall policy.

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

      Project ID for this request.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 739

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetRuleNetworkFirewallPolicyRequest

  # 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_rule.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get_rule.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.get_rule request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #insert(firewall_policy_resource: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Creates a new policy in the specified project using the data included in the request.

Overloads:

  • #insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::InsertNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #insert(firewall_policy_resource: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to insert 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:

    • firewall_policy_resource (::Google::Cloud::Compute::V1::FirewallPolicy, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 807

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertNetworkFirewallPolicyRequest

  # 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.insert.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.insert.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.insert request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy> #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>

Lists all the policies that have been configured for the specified project.

Overloads:

  • #list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::ListNetworkFirewallPoliciesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>

    Pass arguments to list 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:

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

      A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

      The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

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

      Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

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

      Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

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

      Project ID for this request.

    • return_partial_success (::Boolean) (defaults to: nil) —

      Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 889

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListNetworkFirewallPoliciesRequest

  # 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.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.list.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @network_firewall_policies_stub, :list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#patch(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #patch(firewall_policy: nil, firewall_policy_resource: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Patches the specified policy with the data included in the request.

Overloads:

  • #patch(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::PatchNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #patch(firewall_policy: nil, firewall_policy_resource: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to patch 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:

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

      Name of the firewall policy to update.

    • firewall_policy_resource (::Google::Cloud::Compute::V1::FirewallPolicy, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 960

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchNetworkFirewallPolicyRequest

  # 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.patch.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.patch.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.patch request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#patch_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #patch_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Patches a rule of the specified priority.

Overloads:

  • #patch_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::PatchRuleNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #patch_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to patch_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:

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

      Name of the firewall policy to update.

    • firewall_policy_rule_resource (::Google::Cloud::Compute::V1::FirewallPolicyRule, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      The priority of the rule to patch.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 1040

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchRuleNetworkFirewallPolicyRequest

  # 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.patch_rule.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.patch_rule.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.patch_rule request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#remove_association(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #remove_association(firewall_policy: nil, name: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Removes an association for the specified firewall policy.

Overloads:

  • #remove_association(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::RemoveAssociationNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #remove_association(firewall_policy: nil, name: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to remove_association 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:

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

      Name of the firewall policy to update.

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

      Name for the attachment that will be removed.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 1118

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveAssociationNetworkFirewallPolicyRequest

  # 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.remove_association.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.remove_association.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.remove_association request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#remove_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #remove_rule(firewall_policy: nil, priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

Deletes a rule of the specified priority.

Overloads:

  • #remove_rule(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::RemoveRuleNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #remove_rule(firewall_policy: nil, priority: nil, project: nil, request_id: nil) ⇒ ::Gapic::GenericLRO::Operation

    Pass arguments to remove_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:

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

      Name of the firewall policy to update.

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

      The priority of the rule to remove from the firewall policy.

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

      Project ID for this request.

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

      An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

  • result (::Gapic::GenericLRO::Operation)
  • response (::Faraday::Response)

Returns:

  • (::Gapic::GenericLRO::Operation)

Raises:

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

    if the REST call is aborted.



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 1196

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveRuleNetworkFirewallPolicyRequest

  # 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.remove_rule.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.remove_rule.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.remove_rule request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: global_operations,
      request_values: {
        "project" => request.project
      },
      options: options
    )
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#set_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy #set_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Overloads:

  • #set_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::SetIamPolicyNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #set_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

    Pass arguments to set_iam_policy 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:

    • global_set_policy_request_resource (::Google::Cloud::Compute::V1::GlobalSetPolicyRequest, ::Hash) (defaults to: nil) —

      The body resource for this request

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

      Project ID for this request.

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

      Name or id of the resource for this request.

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 1272

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetIamPolicyNetworkFirewallPolicyRequest

  # 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.set_iam_policy.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.set_iam_policy request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end

#test_iam_permissions(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse #test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Overloads:

  • #test_iam_permissions(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse

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

    Parameters:

    • request (::Google::Cloud::Compute::V1::TestIamPermissionsNetworkFirewallPolicyRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

  • #test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse

    Pass arguments to test_iam_permissions 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:

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

      Project ID for this request.

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

      Name or id of the resource for this request.

    • test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) (defaults to: nil) —

      The body resource for this request

Yields:

  • (result, response) —

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/google/cloud/compute/v1/network_firewall_policies/rest/client.rb', line 1340

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::TestIamPermissionsNetworkFirewallPolicyRequest

  # 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.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client header
  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::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                         metadata:     call_metadata

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

  @network_firewall_policies_stub.test_iam_permissions request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  begin
    raise ::Gapic::Rest::Error.wrap_faraday_error e
  rescue ::Gapic::Rest::Error => gapic_error
    raise ::Google::Cloud::Error.from_error gapic_error
  end
end