Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client (v3.5.0)

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

REST client for the OrganizationSecurityPolicies service.

The OrganizationSecurityPolicies API.

Inherits

  • Object

Methods

.configure

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

Configure the OrganizationSecurityPolicies 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 OrganizationSecurityPolicies clients
::Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_association

def add_association(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_association(replace_existing_association: nil, request_id: nil, security_policy: nil, security_policy_association_resource: nil) -> ::Gapic::GenericLRO::Operation

Inserts an association for the specified security policy.

This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addAssociation instead.

Overloads 
def add_association(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to add_association via a request object, either of type AddAssociationOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters 
def add_association(replace_existing_association: nil, request_id: nil, security_policy: nil, security_policy_association_resource: 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
  • 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).

  • security_policy (::String) — Name of the security policy to update.
  • security_policy_association_resource (::Google::Cloud::Compute::V1::SecurityPolicyAssociation, ::Hash) — The body resource for this request
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::AddAssociationOrganizationSecurityPolicyRequest.new

# Call the add_association method.
result = client.add_association request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#add_rule

def add_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_rule(request_id: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::GenericLRO::Operation

Inserts a rule into a security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addRule instead.

Overloads 
def add_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to add_rule via a request object, either of type AddRuleOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::AddRuleOrganizationSecurityPolicyRequest, ::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. 
def add_rule(request_id: nil, security_policy: nil, security_policy_rule_resource: 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
  • 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_rule_resource (::Google::Cloud::Compute::V1::SecurityPolicyRule, ::Hash) — The body resource for this request
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::AddRuleOrganizationSecurityPolicyRequest.new

# Call the add_rule method.
result = client.add_rule request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#configure

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

Configure the OrganizationSecurityPolicies 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

#copy_rules

def copy_rules(request, options = nil) -> ::Gapic::GenericLRO::Operation
def copy_rules(request_id: nil, security_policy: nil, source_security_policy: nil) -> ::Gapic::GenericLRO::Operation

Copies rules to the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.cloneRules instead.

Overloads 
def copy_rules(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to copy_rules via a request object, either of type CopyRulesOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::CopyRulesOrganizationSecurityPolicyRequest, ::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. 
def copy_rules(request_id: nil, security_policy: nil, source_security_policy: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to copy_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
  • 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.
  • source_security_policy (::String) — The security policy from which to copy rules.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::CopyRulesOrganizationSecurityPolicyRequest.new

# Call the copy_rules method.
result = client.copy_rules request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#delete

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(request_id: nil, security_policy: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified policy.

Use this API to remove Cloud Armor policies. Previously, alpha and beta versions of this API were used to remove firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.delete instead.

Overloads 
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to delete via a request object, either of type DeleteOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::DeleteOrganizationSecurityPolicyRequest, ::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. 
def delete(request_id: nil, security_policy: 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
  • 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, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::DeleteOrganizationSecurityPolicyRequest.new

# Call the delete method.
result = client.delete request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#get

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

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

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.get instead.

Overloads 
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicy
Pass arguments to get via a request object, either of type GetOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetOrganizationSecurityPolicyRequest, ::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. 
def get(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).
Parameter
  • security_policy (::String) — Name of the security policy to get.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetOrganizationSecurityPolicyRequest.new

# Call the get method.
result = client.get request

# The returned object is of type Google::Cloud::Compute::V1::SecurityPolicy.
p result

#get_association

def get_association(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyAssociation
def get_association(name: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyAssociation

Gets an association with the specified name.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getAssociation instead.

Overloads 
def get_association(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyAssociation
Pass arguments to get_association via a request object, either of type GetAssociationOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters 
def get_association(name: nil, security_policy: nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyAssociation
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
  • name (::String) — The name of the association to get from the security policy.
  • security_policy (::String) — Name of the security policy to which the queried rule belongs.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetAssociationOrganizationSecurityPolicyRequest.new

# Call the get_association method.
result = client.get_association request

# The returned object is of type Google::Cloud::Compute::V1::SecurityPolicyAssociation.
p result

#get_rule

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

Gets a rule at the specified priority.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getRule instead.

Overloads 
def get_rule(request, options = nil) -> ::Google::Cloud::Compute::V1::SecurityPolicyRule
Pass arguments to get_rule via a request object, either of type GetRuleOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::GetRuleOrganizationSecurityPolicyRequest, ::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. 
def get_rule(priority: 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.
  • security_policy (::String) — Name of the security policy to which the queried rule belongs.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetRuleOrganizationSecurityPolicyRequest.new

# Call the get_rule method.
result = client.get_rule request

# The returned object is of type Google::Cloud::Compute::V1::SecurityPolicyRule.
p result

#global_organization_operations

def global_organization_operations() -> ::Google::Cloud::Compute::V1::GlobalOrganizationOperations::Rest::Client

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

Returns

#initialize

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

Create a new OrganizationSecurityPolicies REST client object.

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

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

#insert

def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(parent_id: nil, request_id: nil, security_policy_resource: nil) -> ::Gapic::GenericLRO::Operation

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

Use this API to add Cloud Armor policies. Previously, alpha and beta versions of this API were used to add firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.insert instead.

Overloads 
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to insert via a request object, either of type InsertOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::InsertOrganizationSecurityPolicyRequest, ::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. 
def insert(parent_id: nil, request_id: nil, security_policy_resource: 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
  • 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).

  • security_policy_resource (::Google::Cloud::Compute::V1::SecurityPolicy, ::Hash) — The body resource for this request
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::InsertOrganizationSecurityPolicyRequest.new

# Call the insert method.
result = client.insert request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#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, parent_id: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::SecurityPolicy>

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

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.list instead.

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 ListOrganizationSecurityPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::ListOrganizationSecurityPoliciesRequest, ::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. 
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::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

    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 :* 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 onresource 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 GoogleRE2 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.

    You cannot combine constraints on multiple fields using regular expressions.

  • 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.
  • 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.

    For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListOrganizationSecurityPoliciesRequest.new

# Call the list method.
result = client.list request

# The returned object is of type Google::Cloud::Compute::V1::SecurityPolicyList.
p result

#list_associations

def list_associations(request, options = nil) -> ::Google::Cloud::Compute::V1::OrganizationSecurityPoliciesListAssociationsResponse
def list_associations(target_resource: nil) -> ::Google::Cloud::Compute::V1::OrganizationSecurityPoliciesListAssociationsResponse

Lists associations of a specified target, i.e., organization or folder.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.listAssociations instead.

Overloads 
def list_associations(request, options = nil) -> ::Google::Cloud::Compute::V1::OrganizationSecurityPoliciesListAssociationsResponse
Pass arguments to list_associations via a request object, either of type ListAssociationsOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters 
def list_associations(target_resource: nil) -> ::Google::Cloud::Compute::V1::OrganizationSecurityPoliciesListAssociationsResponse
Pass arguments to 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).
Parameter
  • target_resource (::String) — The target resource to list associations. It is an organization, or a folder.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListAssociationsOrganizationSecurityPolicyRequest.new

# Call the list_associations method.
result = client.list_associations request

# The returned object is of type Google::Cloud::Compute::V1::OrganizationSecurityPoliciesListAssociationsResponse.
p result

#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, parent_id: 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 ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest or an equivalent Hash.
Parameters 
def list_preconfigured_expression_sets(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: 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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

    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 :* 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 onresource 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 GoogleRE2 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.

    You cannot combine constraints on multiple fields using regular expressions.

  • 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.
  • 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.

    For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest.new

# Call the list_preconfigured_expression_sets method.
result = client.list_preconfigured_expression_sets request

# The returned object is of type Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse.
p result

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#move

def move(request, options = nil) -> ::Gapic::GenericLRO::Operation
def move(parent_id: nil, request_id: nil, security_policy: nil) -> ::Gapic::GenericLRO::Operation

Moves the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.move instead.

Overloads 
def move(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to move via a request object, either of type MoveOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::MoveOrganizationSecurityPolicyRequest, ::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. 
def move(parent_id: nil, request_id: nil, security_policy: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to 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).
Parameters
  • parent_id (::String) — The new parent of the security 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).

  • security_policy (::String) — Name of the security policy to update.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::MoveOrganizationSecurityPolicyRequest.new

# Call the move method.
result = client.move request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#patch

def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(request_id: nil, security_policy: nil, security_policy_resource: nil) -> ::Gapic::GenericLRO::Operation

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

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patch instead.

Overloads 
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to patch via a request object, either of type PatchOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchOrganizationSecurityPolicyRequest, ::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. 
def patch(request_id: nil, security_policy: nil, security_policy_resource: 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
  • 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, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::PatchOrganizationSecurityPolicyRequest.new

# Call the patch method.
result = client.patch request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#patch_rule

def patch_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch_rule(priority: nil, request_id: nil, security_policy: nil, security_policy_rule_resource: nil) -> ::Gapic::GenericLRO::Operation

Patches a rule at the specified priority.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patchRule instead.

Overloads 
def patch_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to patch_rule via a request object, either of type PatchRuleOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::PatchRuleOrganizationSecurityPolicyRequest, ::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. 
def patch_rule(priority: nil, request_id: nil, security_policy: nil, security_policy_rule_resource: 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
  • 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).

  • 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, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::PatchRuleOrganizationSecurityPolicyRequest.new

# Call the patch_rule method.
result = client.patch_rule request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#remove_association

def remove_association(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_association(name: nil, request_id: nil, security_policy: nil) -> ::Gapic::GenericLRO::Operation

Removes an association for the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeAssociation instead.

Overloads 
def remove_association(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to remove_association via a request object, either of type RemoveAssociationOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters 
def remove_association(name: nil, request_id: nil, security_policy: 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
  • 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).

  • security_policy (::String) — Name of the security policy to update.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::RemoveAssociationOrganizationSecurityPolicyRequest.new

# Call the remove_association method.
result = client.remove_association request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#remove_rule

def remove_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_rule(priority: nil, request_id: nil, security_policy: nil) -> ::Gapic::GenericLRO::Operation

Deletes a rule at the specified priority.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeRule instead.

Overloads 
def remove_rule(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to remove_rule via a request object, either of type RemoveRuleOrganizationSecurityPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Compute::V1::RemoveRuleOrganizationSecurityPolicyRequest, ::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. 
def remove_rule(priority: nil, request_id: nil, security_policy: 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
  • priority (::Integer) — The priority of the rule to remove from the security 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).

  • security_policy (::String) — Name of the security policy to update.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::GenericLRO::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::GenericLRO::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::OrganizationSecurityPolicies::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::RemoveRuleOrganizationSecurityPolicyRequest.new

# Call the remove_rule method.
result = client.remove_rule request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)