REST client for the FirewallPolicies service.
The FirewallPolicies API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the FirewallPolicies Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all FirewallPolicies clients ::Google::Cloud::Compute::V1::FirewallPolicies::Rest::Client.configure do |config| config.timeout = 10.0 end
#add_association
def add_association(request, options = nil) -> ::Gapic::Rest::BaseOperation
def add_association(firewall_policy: nil, firewall_policy_association_resource: nil, replace_existing_association: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Inserts an association for the specified firewall policy.
def add_association(request, options = nil) -> ::Gapic::Rest::BaseOperation
add_association
via a request object, either of type
AddAssociationFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddAssociationFirewallPolicyRequest, ::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) — 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
def add_association(firewall_policy: nil, firewall_policy_association_resource: nil, replace_existing_association: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- firewall_policy_association_resource (::Google::Cloud::Compute::V1::FirewallPolicyAssociation, ::Hash) — The body resource for this request
- replace_existing_association (::Boolean) — 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) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#add_rule
def add_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def add_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Inserts a rule into a firewall policy.
def add_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
add_rule
via a request object, either of type
AddRuleFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddRuleFirewallPolicyRequest, ::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) — 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
def add_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- firewall_policy_rule_resource (::Google::Cloud::Compute::V1::FirewallPolicyRule, ::Hash) — The body resource for this request
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#clone_rules
def clone_rules(request, options = nil) -> ::Gapic::Rest::BaseOperation
def clone_rules(firewall_policy: nil, request_id: nil, source_firewall_policy: nil) -> ::Gapic::Rest::BaseOperation
Copies rules to the specified firewall policy.
def clone_rules(request, options = nil) -> ::Gapic::Rest::BaseOperation
clone_rules
via a request object, either of type
CloneRulesFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::CloneRulesFirewallPolicyRequest, ::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) — 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
def clone_rules(firewall_policy: nil, request_id: nil, source_firewall_policy: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- request_id (::String) — 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) — The firewall policy from which to copy rules.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the FirewallPolicies Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#delete
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(firewall_policy: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Deletes the specified policy.
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
delete
via a request object, either of type
DeleteFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteFirewallPolicyRequest, ::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) — 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
def delete(firewall_policy: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to delete.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicy
def get(firewall_policy: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicy
Returns the specified firewall policy.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicy
get
via a request object, either of type
GetFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetFirewallPolicyRequest, ::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) — 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
def get(firewall_policy: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicy
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).
- firewall_policy (::String) — Name of the firewall policy to get.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::FirewallPolicy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_association
def get_association(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyAssociation
def get_association(firewall_policy: nil, name: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyAssociation
Gets an association with the specified name.
def get_association(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyAssociation
get_association
via a request object, either of type
GetAssociationFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetAssociationFirewallPolicyRequest, ::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) — 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
def get_association(firewall_policy: nil, name: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyAssociation
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).
- firewall_policy (::String) — Name of the firewall policy to which the queried rule belongs.
- name (::String) — The name of the association to get from the firewall policy.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::FirewallPolicyAssociation)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def get_iam_policy(options_requested_policy_version: 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.
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
via a request object, either of type
GetIamPolicyFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetIamPolicyFirewallPolicyRequest, ::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) — 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
def get_iam_policy(options_requested_policy_version: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
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).
- options_requested_policy_version (::Integer) — Requested IAM Policy version.
- resource (::String) — Name or id of the resource for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_rule
def get_rule(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyRule
def get_rule(firewall_policy: nil, priority: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyRule
Gets a rule of the specified priority.
def get_rule(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyRule
get_rule
via a request object, either of type
GetRuleFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetRuleFirewallPolicyRequest, ::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) — 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
def get_rule(firewall_policy: nil, priority: nil) -> ::Google::Cloud::Compute::V1::FirewallPolicyRule
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).
- firewall_policy (::String) — Name of the firewall policy to which the queried rule belongs.
- priority (::Integer) — The priority of the rule to get from the firewall policy.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::FirewallPolicyRule)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new FirewallPolicies REST client object.
- (config) — Configure the FirewallPolicies client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::FirewallPolicies::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::FirewallPolicies::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(firewall_policy_resource: nil, parent_id: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Creates a new policy in the specified project using the data included in the request.
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
insert
via a request object, either of type
InsertFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertFirewallPolicyRequest, ::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) — 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
def insert(firewall_policy_resource: nil, parent_id: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy_resource (::Google::Cloud::Compute::V1::FirewallPolicy, ::Hash) — The body resource for this request
- parent_id (::String) — Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>
Lists all the policies that have been configured for the specified folder or organization.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>
list
via a request object, either of type
ListFirewallPoliciesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListFirewallPoliciesRequest, ::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) — 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
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>
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).
-
filter (::String) — A filter expression that filters resources listed in the response. The 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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
-
max_results (::Integer) — The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) -
order_by (::String) — 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - parent_id (::String) — Parent ID for this request.
- return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::FirewallPolicy>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list_associations
def list_associations(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPoliciesListAssociationsResponse
def list_associations(target_resource: nil) -> ::Google::Cloud::Compute::V1::FirewallPoliciesListAssociationsResponse
Lists associations of a specified target, i.e., organization or folder.
def list_associations(request, options = nil) -> ::Google::Cloud::Compute::V1::FirewallPoliciesListAssociationsResponse
list_associations
via a request object, either of type
ListAssociationsFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListAssociationsFirewallPolicyRequest, ::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) — 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
def list_associations(target_resource: nil) -> ::Google::Cloud::Compute::V1::FirewallPoliciesListAssociationsResponse
list_associations
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).
- target_resource (::String) — The target resource to list associations. It is an organization, or a folder.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::FirewallPoliciesListAssociationsResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#move
def move(request, options = nil) -> ::Gapic::Rest::BaseOperation
def move(firewall_policy: nil, parent_id: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Moves the specified firewall policy.
def move(request, options = nil) -> ::Gapic::Rest::BaseOperation
move
via a request object, either of type
MoveFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::MoveFirewallPolicyRequest, ::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) — 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
def move(firewall_policy: nil, parent_id: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
move
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- parent_id (::String) — The new parent of the firewall policy.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(firewall_policy: nil, firewall_policy_resource: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Patches the specified policy with the data included in the request.
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
patch
via a request object, either of type
PatchFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchFirewallPolicyRequest, ::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) — 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
def patch(firewall_policy: nil, firewall_policy_resource: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- firewall_policy_resource (::Google::Cloud::Compute::V1::FirewallPolicy, ::Hash) — The body resource for this request
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch_rule
def patch_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, priority: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Patches a rule of the specified priority.
def patch_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
patch_rule
via a request object, either of type
PatchRuleFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchRuleFirewallPolicyRequest, ::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) — 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
def patch_rule(firewall_policy: nil, firewall_policy_rule_resource: nil, priority: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- firewall_policy_rule_resource (::Google::Cloud::Compute::V1::FirewallPolicyRule, ::Hash) — The body resource for this request
- priority (::Integer) — The priority of the rule to patch.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#remove_association
def remove_association(request, options = nil) -> ::Gapic::Rest::BaseOperation
def remove_association(firewall_policy: nil, name: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Removes an association for the specified firewall policy.
def remove_association(request, options = nil) -> ::Gapic::Rest::BaseOperation
remove_association
via a request object, either of type
RemoveAssociationFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::RemoveAssociationFirewallPolicyRequest, ::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) — 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
def remove_association(firewall_policy: nil, name: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- name (::String) — Name for the attachment that will be removed.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#remove_rule
def remove_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def remove_rule(firewall_policy: nil, priority: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Deletes a rule of the specified priority.
def remove_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
remove_rule
via a request object, either of type
RemoveRuleFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::RemoveRuleFirewallPolicyRequest, ::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) — 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
def remove_rule(firewall_policy: nil, priority: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_policy (::String) — Name of the firewall policy to update.
- priority (::Integer) — The priority of the rule to remove from the firewall policy.
- request_id (::String) — 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(global_organization_set_policy_request_resource: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
via a request object, either of type
SetIamPolicyFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetIamPolicyFirewallPolicyRequest, ::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) — 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
def set_iam_policy(global_organization_set_policy_request_resource: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
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).
- global_organization_set_policy_request_resource (::Google::Cloud::Compute::V1::GlobalOrganizationSetPolicyRequest, ::Hash) — The body resource for this request
- resource (::String) — Name or id of the resource for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via a request object, either of type
TestIamPermissionsFirewallPolicyRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::TestIamPermissionsFirewallPolicyRequest, ::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) — 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
def test_iam_permissions(resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
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).
- resource (::String) — Name or id of the resource for this request.
- test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.