Class Google::Cloud::Compute::V1::SecurityPolicies::Rest::Client (v1.1.0)

REST client for the SecurityPolicies service.

The SecurityPolicies API.

Inherits

  • Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the SecurityPolicies Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all SecurityPolicies clients
::Google::Cloud::Compute::V1::SecurityPolicies::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_rule

def add_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def add_rule(project: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::Rest::BaseOperation

Inserts a rule into a security policy.

Overloads 
def add_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to add_rule via a request object, either of type AddRuleSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::AddRuleSecurityPolicyRequest, ::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(project: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::Rest::BaseOperation
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
  • project (::String) — Project ID for this request.
  • security_policy (::String) — Name of the security policy to update.
  • security_policy_rule_resource (::Google::Cloud::Compute::V1::SecurityPolicyRule, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the SecurityPolicies 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.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#delete

def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(project: nil, request_id: nil, security_policy: nil) -> ::Gapic::Rest::BaseOperation

Deletes the specified policy.

Overloads 
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to delete via a request object, either of type DeleteSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::DeleteSecurityPolicyRequest, ::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(project: nil, request_id: nil, security_policy: nil) -> ::Gapic::Rest::BaseOperation
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
  • project (::String) — Project ID 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).
  • security_policy (::String) — Name of the security policy to delete.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicy
def get(project: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicy

List all of the ordered rules present in a single specified policy.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicy
Pass arguments to get via a request object, either of type GetSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetSecurityPolicyRequest, ::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(project: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicy
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
  • project (::String) — Project ID for this request.
  • security_policy (::String) — Name of the security policy to get.
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.

#get_rule

def get_rule(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyRule
def get_rule(priority: nil, project: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyRule

Gets a rule at the specified priority.

Overloads 
def get_rule(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyRule
Pass arguments to get_rule via a request object, either of type GetRuleSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetRuleSecurityPolicyRequest, ::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(priority: nil, project: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyRule
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
  • priority (::Integer) — The priority of the rule to get from the security policy.
  • project (::String) — Project ID for this request.
  • security_policy (::String) — Name of the security policy to which the queried rule belongs.
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.

#initialize

def initialize() { |config| ... } -> Client

Create a new SecurityPolicies REST client object.

Yields
  • (config) — Configure the SecurityPolicies client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::SecurityPolicies::Rest::Client.new

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

#insert

def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(project: nil, request_id: nil, security_policy_resource: nil) -> ::Gapic::Rest::BaseOperation

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

Overloads 
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to insert via a request object, either of type InsertSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::InsertSecurityPolicyRequest, ::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(project: nil, request_id: nil, security_policy_resource: nil) -> ::Gapic::Rest::BaseOperation
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
  • project (::String) — Project ID 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).
  • security_policy_resource (::Google::Cloud::Compute::V1::SecurityPolicy, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::SecurityPolicy>
def 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::SecurityPolicy>

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

Overloads 
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::SecurityPolicy>
Pass arguments to list via a request object, either of type ListSecurityPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::ListSecurityPoliciesRequest, ::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, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::SecurityPolicy>
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) — 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 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)
  • 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 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) — 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) — 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) — Project 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.
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.

#list_preconfigured_expression_sets

def list_preconfigured_expression_sets(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse
def list_preconfigured_expression_sets(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Overloads 
def list_preconfigured_expression_sets(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse
Pass arguments to list_preconfigured_expression_sets via a request object, either of type ListPreconfiguredExpressionSetsSecurityPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::ListPreconfiguredExpressionSetsSecurityPoliciesRequest, ::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_preconfigured_expression_sets(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse
Pass arguments to list_preconfigured_expression_sets 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) — 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 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)
  • 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 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) — 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) — 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) — Project 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.
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.

#patch

def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(project: nil, request_id: nil, security_policy: nil, security_policy_resource: nil) -> ::Gapic::Rest::BaseOperation

Patches the specified policy with the data included in the request. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.

Overloads 
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to patch via a request object, either of type PatchSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchSecurityPolicyRequest, ::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(project: nil, request_id: nil, security_policy: nil, security_policy_resource: nil) -> ::Gapic::Rest::BaseOperation
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
  • project (::String) — Project ID 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).
  • security_policy (::String) — Name of the security policy to update.
  • security_policy_resource (::Google::Cloud::Compute::V1::SecurityPolicy, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#patch_rule

def patch_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch_rule(priority: nil, project: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::Rest::BaseOperation

Patches a rule at the specified priority.

Overloads 
def patch_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to patch_rule via a request object, either of type PatchRuleSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchRuleSecurityPolicyRequest, ::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(priority: nil, project: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::Rest::BaseOperation
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
  • priority (::Integer) — The priority of the rule to patch.
  • project (::String) — Project ID for this request.
  • security_policy (::String) — Name of the security policy to update.
  • security_policy_rule_resource (::Google::Cloud::Compute::V1::SecurityPolicyRule, ::Hash) — The body resource for this request
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#remove_rule

def remove_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
def remove_rule(priority: nil, project: nil, security_policy: nil) -> ::Gapic::Rest::BaseOperation

Deletes a rule at the specified priority.

Overloads 
def remove_rule(request, options = nil) -> ::Gapic::Rest::BaseOperation
Pass arguments to remove_rule via a request object, either of type RemoveRuleSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::RemoveRuleSecurityPolicyRequest, ::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(priority: nil, project: nil, security_policy: nil) -> ::Gapic::Rest::BaseOperation
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
  • priority (::Integer) — The priority of the rule to remove from the security policy.
  • project (::String) — Project ID for this request.
  • security_policy (::String) — Name of the security policy to update.
Yields
  • (result, response) — Access the result along with the Faraday response object
Yield Parameters
  • result (::Gapic::Rest::BaseOperation)
  • response (::Faraday::Response)
Returns
  • (::Gapic::Rest::BaseOperation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.