Network Security V1 API - Class Google::Cloud::NetworkSecurity::V1::FirewallActivation::Client (v0.1.0)

Reference documentation and code samples for the Network Security V1 API class Google::Cloud::NetworkSecurity::V1::FirewallActivation::Client.

Client for the FirewallActivation service.

Service for managing Firewall Endpoints and Associations.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

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

#create_firewall_endpoint

def create_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def create_firewall_endpoint(parent: nil, firewall_endpoint_id: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation

Creates a new FirewallEndpoint in a given organization and location.

Overloads 
def create_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_firewall_endpoint via a request object, either of type CreateFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::CreateFirewallEndpointRequest, ::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 create_firewall_endpoint(parent: nil, firewall_endpoint_id: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_firewall_endpoint 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 (::String) — Required. Value for parent.
  • firewall_endpoint_id (::String) — Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.
  • firewall_endpoint (::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_firewall_endpoint_association

def create_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
def create_firewall_endpoint_association(parent: nil, firewall_endpoint_association_id: nil, firewall_endpoint_association: nil, request_id: nil) -> ::Gapic::Operation

Creates a new FirewallEndpointAssociation in a given project and location.

Overloads 
def create_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_firewall_endpoint_association via a request object, either of type CreateFirewallEndpointAssociationRequest or an equivalent Hash.
Parameters 
def create_firewall_endpoint_association(parent: nil, firewall_endpoint_association_id: nil, firewall_endpoint_association: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_firewall_endpoint_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
  • parent (::String) — Required. Value for parent.
  • firewall_endpoint_association_id (::String) — Optional. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_association_id from the method_signature of Create RPC.
  • firewall_endpoint_association (::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_project_firewall_endpoint

def create_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def create_project_firewall_endpoint(parent: nil, firewall_endpoint_id: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation

Creates a new FirewallEndpoint in a given project and location.

Overloads 
def create_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_project_firewall_endpoint via a request object, either of type CreateFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::CreateFirewallEndpointRequest, ::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 create_project_firewall_endpoint(parent: nil, firewall_endpoint_id: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_project_firewall_endpoint 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 (::String) — Required. Value for parent.
  • firewall_endpoint_id (::String) — Required. Id of the requesting object. If auto-generating Id server-side, remove this field and firewall_endpoint_id from the method_signature of Create RPC.
  • firewall_endpoint (::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_firewall_endpoint

def delete_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def delete_firewall_endpoint(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single org Endpoint.

Overloads 
def delete_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_firewall_endpoint via a request object, either of type DeleteFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::DeleteFirewallEndpointRequest, ::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_firewall_endpoint(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_firewall_endpoint 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) — Required. Name of the resource
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_firewall_endpoint_association

def delete_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
def delete_firewall_endpoint_association(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single FirewallEndpointAssociation.

Overloads 
def delete_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_firewall_endpoint_association via a request object, either of type DeleteFirewallEndpointAssociationRequest or an equivalent Hash.
Parameters 
def delete_firewall_endpoint_association(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_firewall_endpoint_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) — Required. Name of the resource
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_project_firewall_endpoint

def delete_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def delete_project_firewall_endpoint(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single project Endpoint.

Overloads 
def delete_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_project_firewall_endpoint via a request object, either of type DeleteFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::DeleteFirewallEndpointRequest, ::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_project_firewall_endpoint(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_project_firewall_endpoint 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) — Required. Name of the resource
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_firewall_endpoint

def get_firewall_endpoint(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
def get_firewall_endpoint(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint

Gets details of a single org Endpoint.

Overloads 
def get_firewall_endpoint(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
Pass arguments to get_firewall_endpoint via a request object, either of type GetFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetFirewallEndpointRequest, ::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_firewall_endpoint(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
Pass arguments to get_firewall_endpoint 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
  • name (::String) — Required. Name of the resource
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkSecurity::V1::FirewallEndpoint.
p result

#get_firewall_endpoint_association

def get_firewall_endpoint_association(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation
def get_firewall_endpoint_association(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation

Gets details of a single FirewallEndpointAssociation.

Overloads 
def get_firewall_endpoint_association(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation
Pass arguments to get_firewall_endpoint_association via a request object, either of type GetFirewallEndpointAssociationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetFirewallEndpointAssociationRequest, ::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_firewall_endpoint_association(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation
Pass arguments to get_firewall_endpoint_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).
Parameter
  • name (::String) — Required. Name of the resource
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation.
p result

#get_project_firewall_endpoint

def get_project_firewall_endpoint(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
def get_project_firewall_endpoint(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint

Gets details of a single project Endpoint.

Overloads 
def get_project_firewall_endpoint(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
Pass arguments to get_project_firewall_endpoint via a request object, either of type GetFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetFirewallEndpointRequest, ::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_project_firewall_endpoint(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint
Pass arguments to get_project_firewall_endpoint 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
  • name (::String) — Required. Name of the resource
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Google::Cloud::NetworkSecurity::V1::FirewallEndpoint.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new FirewallActivation client object.

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

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

#list_firewall_endpoint_associations

def list_firewall_endpoint_associations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation>
def list_firewall_endpoint_associations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation>

Lists Associations in a given project and location.

Overloads 
def list_firewall_endpoint_associations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation>
Pass arguments to list_firewall_endpoint_associations via a request object, either of type ListFirewallEndpointAssociationsRequest or an equivalent Hash.
Parameters 
def list_firewall_endpoint_associations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation>
Pass arguments to list_firewall_endpoint_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).
Parameters
  • parent (::String) — Required. Parent value for ListAssociationsRequest
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results
  • order_by (::String) — Hint for how to order the results
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation.
  p item
end

#list_firewall_endpoints

def list_firewall_endpoints(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
def list_firewall_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>

Lists FirewallEndpoints in a given organization and location.

Overloads 
def list_firewall_endpoints(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
Pass arguments to list_firewall_endpoints via a request object, either of type ListFirewallEndpointsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::ListFirewallEndpointsRequest, ::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_firewall_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
Pass arguments to list_firewall_endpoints 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 (::String) — Required. Parent value for ListEndpointsRequest
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results
  • order_by (::String) — Hint for how to order the results
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint.
  p item
end

#list_project_firewall_endpoints

def list_project_firewall_endpoints(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
def list_project_firewall_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>

Lists FirewallEndpoints in a given project and location.

Overloads 
def list_project_firewall_endpoints(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
Pass arguments to list_project_firewall_endpoints via a request object, either of type ListFirewallEndpointsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::ListFirewallEndpointsRequest, ::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_project_firewall_endpoints(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint>
Pass arguments to list_project_firewall_endpoints 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 (::String) — Required. Parent value for ListEndpointsRequest
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Optional. Filtering results
  • order_by (::String) — Hint for how to order the results
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::NetworkSecurity::V1::FirewallActivation::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_firewall_endpoint

def update_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def update_firewall_endpoint(update_mask: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation

Update a single org Endpoint.

Overloads 
def update_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_firewall_endpoint via a request object, either of type UpdateFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::UpdateFirewallEndpointRequest, ::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 update_firewall_endpoint(update_mask: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_firewall_endpoint 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • firewall_endpoint (::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_firewall_endpoint_association

def update_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
def update_firewall_endpoint_association(update_mask: nil, firewall_endpoint_association: nil, request_id: nil) -> ::Gapic::Operation

Update a single FirewallEndpointAssociation.

Overloads 
def update_firewall_endpoint_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_firewall_endpoint_association via a request object, either of type UpdateFirewallEndpointAssociationRequest or an equivalent Hash.
Parameters 
def update_firewall_endpoint_association(update_mask: nil, firewall_endpoint_association: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_firewall_endpoint_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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Association resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • firewall_endpoint_association (::Google::Cloud::NetworkSecurity::V1::FirewallEndpointAssociation, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_project_firewall_endpoint

def update_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
def update_project_firewall_endpoint(update_mask: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation

Update a single project Endpoint.

Overloads 
def update_project_firewall_endpoint(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_project_firewall_endpoint via a request object, either of type UpdateFirewallEndpointRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::UpdateFirewallEndpointRequest, ::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 update_project_firewall_endpoint(update_mask: nil, firewall_endpoint: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_project_firewall_endpoint 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • firewall_endpoint (::Google::Cloud::NetworkSecurity::V1::FirewallEndpoint, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end