Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::NetworkFirewallPolicies::Rest::ServiceStub (v1.3.0)

Version 1.3.0

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::NetworkFirewallPolicies::Rest::ServiceStub.

REST service stub for the NetworkFirewallPolicies service. service stub contains baseline method implementations including transcoding, making the REST call and deserialing the response

Inherits

• Object

Methods

#add_association

def add_association(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the add_association REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::AddAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#add_rule

def add_rule(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the add_rule REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::AddRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#clone_rules

def clone_rules(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the clone_rules REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::CloneRulesNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete

def delete(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the delete REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::DeleteNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get

def get(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::FirewallPolicy

Baseline implementation for the get REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::FirewallPolicy)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::FirewallPolicy) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_association

def get_association(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::FirewallPolicyAssociation

Baseline implementation for the get_association REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::FirewallPolicyAssociation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::FirewallPolicyAssociation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_iam_policy

def get_iam_policy(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Policy

Baseline implementation for the get_iam_policy REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetIamPolicyNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Policy)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Policy) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_rule

def get_rule(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::FirewallPolicyRule

Baseline implementation for the get_rule REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::FirewallPolicyRule)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::FirewallPolicyRule) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#insert

def insert(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the insert REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::InsertNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list

def list(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::FirewallPolicyList

Baseline implementation for the list REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::ListNetworkFirewallPoliciesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::FirewallPolicyList)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::FirewallPolicyList) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#patch

def patch(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the patch REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::PatchNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#patch_rule

def patch_rule(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the patch_rule REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::PatchRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#remove_association

def remove_association(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the remove_association REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::RemoveAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#remove_rule

def remove_rule(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the remove_rule REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::RemoveRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#set_iam_policy

def set_iam_policy(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Policy

Baseline implementation for the set_iam_policy REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::SetIamPolicyNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Policy)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Policy) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::TestIamPermissionsNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::TestPermissionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#transcode_add_association_request

def transcode_add_association_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the add_association REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::AddAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_add_rule_request

def transcode_add_rule_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the add_rule REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::AddRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_clone_rules_request

def transcode_clone_rules_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the clone_rules REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::CloneRulesNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_delete_request

def transcode_delete_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the delete REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::DeleteNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_association_request

def transcode_get_association_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_association REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_iam_policy_request

def transcode_get_iam_policy_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_iam_policy REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetIamPolicyNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_request

def transcode_get_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_rule_request

def transcode_get_rule_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_rule REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_insert_request

def transcode_insert_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the insert REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::InsertNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_list_request

def transcode_list_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::ListNetworkFirewallPoliciesRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_patch_request

def transcode_patch_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the patch REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::PatchNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_patch_rule_request

def transcode_patch_rule_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the patch_rule REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::PatchRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_remove_association_request

def transcode_remove_association_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the remove_association REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::RemoveAssociationNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_remove_rule_request

def transcode_remove_rule_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the remove_rule REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::RemoveRuleNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_set_iam_policy_request

def transcode_set_iam_policy_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_iam_policy REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::SetIamPolicyNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_test_iam_permissions_request

def transcode_test_iam_permissions_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the test_iam_permissions REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::TestIamPermissionsNetworkFirewallPolicyRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters