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

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

Client for the Mirroring service.

PM2 is the "out-of-band" flavor of the Network Security Integrations product.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the Mirroring 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_mirroring_deployment

def create_mirroring_deployment(request, options = nil) -> ::Gapic::Operation
def create_mirroring_deployment(parent: nil, mirroring_deployment_id: nil, mirroring_deployment: nil, request_id: nil) -> ::Gapic::Operation

Creates a deployment in a given project and location. See https://google.aip.dev/133.

Overloads 
def create_mirroring_deployment(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_deployment via a request object, either of type CreateMirroringDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::CreateMirroringDeploymentRequest, ::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_mirroring_deployment(parent: nil, mirroring_deployment_id: nil, mirroring_deployment: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_deployment 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. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}
  • mirroring_deployment_id (::String) — Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.
  • mirroring_deployment (::Google::Cloud::NetworkSecurity::V1::MirroringDeployment, ::Hash) — Required. The deployment to create.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the create_mirroring_deployment method.
result = client.create_mirroring_deployment 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_mirroring_deployment_group

def create_mirroring_deployment_group(request, options = nil) -> ::Gapic::Operation
def create_mirroring_deployment_group(parent: nil, mirroring_deployment_group_id: nil, mirroring_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Creates a deployment group in a given project and location. See https://google.aip.dev/133.

Overloads 
def create_mirroring_deployment_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_deployment_group via a request object, either of type CreateMirroringDeploymentGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::CreateMirroringDeploymentGroupRequest, ::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_mirroring_deployment_group(parent: nil, mirroring_deployment_group_id: nil, mirroring_deployment_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_deployment_group 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. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}
  • mirroring_deployment_group_id (::String) — Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.
  • mirroring_deployment_group (::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup, ::Hash) — Required. The deployment group to create.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the create_mirroring_deployment_group method.
result = client.create_mirroring_deployment_group 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_mirroring_endpoint_group

def create_mirroring_endpoint_group(request, options = nil) -> ::Gapic::Operation
def create_mirroring_endpoint_group(parent: nil, mirroring_endpoint_group_id: nil, mirroring_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

Creates an endpoint group in a given project and location. See https://google.aip.dev/133.

Overloads 
def create_mirroring_endpoint_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_endpoint_group via a request object, either of type CreateMirroringEndpointGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::CreateMirroringEndpointGroupRequest, ::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_mirroring_endpoint_group(parent: nil, mirroring_endpoint_group_id: nil, mirroring_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_endpoint_group 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. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}
  • mirroring_endpoint_group_id (::String) — Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.
  • mirroring_endpoint_group (::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup, ::Hash) — Required. The endpoint group to create.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the create_mirroring_endpoint_group method.
result = client.create_mirroring_endpoint_group 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_mirroring_endpoint_group_association

def create_mirroring_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
def create_mirroring_endpoint_group_association(parent: nil, mirroring_endpoint_group_association_id: nil, mirroring_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

Creates an association in a given project and location. See https://google.aip.dev/133.

Overloads 
def create_mirroring_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_endpoint_group_association via a request object, either of type CreateMirroringEndpointGroupAssociationRequest or an equivalent Hash.
Parameters 
def create_mirroring_endpoint_group_association(parent: nil, mirroring_endpoint_group_association_id: nil, mirroring_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_mirroring_endpoint_group_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. The parent resource where this association will be created. Format: projects/{project}/locations/{location}
  • mirroring_endpoint_group_association_id (::String) — Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.
  • mirroring_endpoint_group_association (::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation, ::Hash) — Required. The association to create.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the create_mirroring_endpoint_group_association method.
result = client.create_mirroring_endpoint_group_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_mirroring_deployment

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

Deletes a deployment. See https://google.aip.dev/135.

Overloads 
def delete_mirroring_deployment(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_deployment via a request object, either of type DeleteMirroringDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::DeleteMirroringDeploymentRequest, ::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_mirroring_deployment(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_deployment 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. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the delete_mirroring_deployment method.
result = client.delete_mirroring_deployment 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_mirroring_deployment_group

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

Deletes a deployment group. See https://google.aip.dev/135.

Overloads 
def delete_mirroring_deployment_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_deployment_group via a request object, either of type DeleteMirroringDeploymentGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::DeleteMirroringDeploymentGroupRequest, ::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_mirroring_deployment_group(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_deployment_group 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. The deployment group to delete.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the delete_mirroring_deployment_group method.
result = client.delete_mirroring_deployment_group 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_mirroring_endpoint_group

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

Deletes an endpoint group. See https://google.aip.dev/135.

Overloads 
def delete_mirroring_endpoint_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_endpoint_group via a request object, either of type DeleteMirroringEndpointGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::DeleteMirroringEndpointGroupRequest, ::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_mirroring_endpoint_group(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_endpoint_group 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. The endpoint group to delete.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the delete_mirroring_endpoint_group method.
result = client.delete_mirroring_endpoint_group 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_mirroring_endpoint_group_association

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

Deletes an association. See https://google.aip.dev/135.

Overloads 
def delete_mirroring_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_endpoint_group_association via a request object, either of type DeleteMirroringEndpointGroupAssociationRequest or an equivalent Hash.
Parameters 
def delete_mirroring_endpoint_group_association(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_mirroring_endpoint_group_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. The association to delete.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the delete_mirroring_endpoint_group_association method.
result = client.delete_mirroring_endpoint_group_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

#get_mirroring_deployment

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

Gets a specific deployment. See https://google.aip.dev/131.

Overloads 
def get_mirroring_deployment(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringDeployment
Pass arguments to get_mirroring_deployment via a request object, either of type GetMirroringDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetMirroringDeploymentRequest, ::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_mirroring_deployment(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringDeployment
Pass arguments to get_mirroring_deployment 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. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}
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::Mirroring::Client.new

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

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

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

#get_mirroring_deployment_group

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

Gets a specific deployment group. See https://google.aip.dev/131.

Overloads 
def get_mirroring_deployment_group(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup
Pass arguments to get_mirroring_deployment_group via a request object, either of type GetMirroringDeploymentGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetMirroringDeploymentGroupRequest, ::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_mirroring_deployment_group(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup
Pass arguments to get_mirroring_deployment_group 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. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/mirroringDeploymentGroups/{mirroring_deployment_group}
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::Mirroring::Client.new

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

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

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

#get_mirroring_endpoint_group

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

Gets a specific endpoint group. See https://google.aip.dev/131.

Overloads 
def get_mirroring_endpoint_group(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup
Pass arguments to get_mirroring_endpoint_group via a request object, either of type GetMirroringEndpointGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::GetMirroringEndpointGroupRequest, ::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_mirroring_endpoint_group(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup
Pass arguments to get_mirroring_endpoint_group 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. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroups/{mirroring_endpoint_group}
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::Mirroring::Client.new

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

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

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

#get_mirroring_endpoint_group_association

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

Gets a specific association. See https://google.aip.dev/131.

Overloads 
def get_mirroring_endpoint_group_association(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation
Pass arguments to get_mirroring_endpoint_group_association via a request object, either of type GetMirroringEndpointGroupAssociationRequest or an equivalent Hash.
Parameters 
def get_mirroring_endpoint_group_association(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation
Pass arguments to get_mirroring_endpoint_group_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. The name of the association to retrieve. Format: projects/{project}/locations/{location}/mirroringEndpointGroupAssociations/{mirroring_endpoint_group_association}
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::Mirroring::Client.new

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

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

# The returned object is of type Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation.
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 Mirroring client object.

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

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

#list_mirroring_deployment_groups

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

Lists deployment groups in a given project and location. See https://google.aip.dev/132.

Overloads 
def list_mirroring_deployment_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup>
Pass arguments to list_mirroring_deployment_groups via a request object, either of type ListMirroringDeploymentGroupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::ListMirroringDeploymentGroupsRequest, ::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_mirroring_deployment_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup>
Pass arguments to list_mirroring_deployment_groups 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. The parent, which owns this collection of deployment groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
  • page_token (::String) — Optional. A page token, received from a previous ListMirroringDeploymentGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMirroringDeploymentGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
  • filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
  • order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.
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::Mirroring::Client.new

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

# Call the list_mirroring_deployment_groups method.
result = client.list_mirroring_deployment_groups 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::MirroringDeploymentGroup.
  p item
end

#list_mirroring_deployments

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

Lists deployments in a given project and location. See https://google.aip.dev/132.

Overloads 
def list_mirroring_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeployment>
Pass arguments to list_mirroring_deployments via a request object, either of type ListMirroringDeploymentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::ListMirroringDeploymentsRequest, ::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_mirroring_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeployment>
Pass arguments to list_mirroring_deployments 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. The parent, which owns this collection of deployments. Example: projects/123456789/locations/us-central1-a. See https://google.aip.dev/132 for more details.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
  • page_token (::String) — Optional. A page token, received from a previous ListMirroringDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMirroringDeployments must match the call that provided the page token. See https://google.aip.dev/158 for more details.
  • filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
  • order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.
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::Mirroring::Client.new

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

# Call the list_mirroring_deployments method.
result = client.list_mirroring_deployments 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::MirroringDeployment.
  p item
end

#list_mirroring_endpoint_group_associations

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

Lists associations in a given project and location. See https://google.aip.dev/132.

Overloads 
def list_mirroring_endpoint_group_associations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation>
Pass arguments to list_mirroring_endpoint_group_associations via a request object, either of type ListMirroringEndpointGroupAssociationsRequest or an equivalent Hash.
Parameters 
def list_mirroring_endpoint_group_associations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation>
Pass arguments to list_mirroring_endpoint_group_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. The parent, which owns this collection of associations. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
  • page_token (::String) — Optional. A page token, received from a previous ListMirroringEndpointGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMirroringEndpointGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
  • filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
  • order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.
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::Mirroring::Client.new

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

# Call the list_mirroring_endpoint_group_associations method.
result = client.list_mirroring_endpoint_group_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::MirroringEndpointGroupAssociation.
  p item
end

#list_mirroring_endpoint_groups

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

Lists endpoint groups in a given project and location. See https://google.aip.dev/132.

Overloads 
def list_mirroring_endpoint_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup>
Pass arguments to list_mirroring_endpoint_groups via a request object, either of type ListMirroringEndpointGroupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::ListMirroringEndpointGroupsRequest, ::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_mirroring_endpoint_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup>
Pass arguments to list_mirroring_endpoint_groups 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. The parent, which owns this collection of endpoint groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
  • page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
  • page_token (::String) — Optional. A page token, received from a previous ListMirroringEndpointGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMirroringEndpointGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
  • filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
  • order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.
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::Mirroring::Client.new

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

# Call the list_mirroring_endpoint_groups method.
result = client.list_mirroring_endpoint_groups 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::MirroringEndpointGroup.
  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::Mirroring::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_mirroring_deployment

def update_mirroring_deployment(request, options = nil) -> ::Gapic::Operation
def update_mirroring_deployment(update_mask: nil, mirroring_deployment: nil, request_id: nil) -> ::Gapic::Operation

Updates a deployment. See https://google.aip.dev/134.

Overloads 
def update_mirroring_deployment(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_deployment via a request object, either of type UpdateMirroringDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::UpdateMirroringDeploymentRequest, ::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_mirroring_deployment(update_mask: nil, mirroring_deployment: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_deployment 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) — Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. description; not mirroring_deployment.description). See https://google.aip.dev/161 for more details.
  • mirroring_deployment (::Google::Cloud::NetworkSecurity::V1::MirroringDeployment, ::Hash) — Required. The deployment to update.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the update_mirroring_deployment method.
result = client.update_mirroring_deployment 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_mirroring_deployment_group

def update_mirroring_deployment_group(request, options = nil) -> ::Gapic::Operation
def update_mirroring_deployment_group(update_mask: nil, mirroring_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Updates a deployment group. See https://google.aip.dev/134.

Overloads 
def update_mirroring_deployment_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_deployment_group via a request object, either of type UpdateMirroringDeploymentGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::UpdateMirroringDeploymentGroupRequest, ::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_mirroring_deployment_group(update_mask: nil, mirroring_deployment_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_deployment_group 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) — Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. description; not mirroring_deployment_group.description). See https://google.aip.dev/161 for more details.
  • mirroring_deployment_group (::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup, ::Hash) — Required. The deployment group to update.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the update_mirroring_deployment_group method.
result = client.update_mirroring_deployment_group 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_mirroring_endpoint_group

def update_mirroring_endpoint_group(request, options = nil) -> ::Gapic::Operation
def update_mirroring_endpoint_group(update_mask: nil, mirroring_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

Updates an endpoint group. See https://google.aip.dev/134.

Overloads 
def update_mirroring_endpoint_group(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_endpoint_group via a request object, either of type UpdateMirroringEndpointGroupRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::NetworkSecurity::V1::UpdateMirroringEndpointGroupRequest, ::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_mirroring_endpoint_group(update_mask: nil, mirroring_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_endpoint_group 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) — Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. description; not mirroring_endpoint_group.description). See https://google.aip.dev/161 for more details.
  • mirroring_endpoint_group (::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup, ::Hash) — Required. The endpoint group to update.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the update_mirroring_endpoint_group method.
result = client.update_mirroring_endpoint_group 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_mirroring_endpoint_group_association

def update_mirroring_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
def update_mirroring_endpoint_group_association(update_mask: nil, mirroring_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

Updates an association. See https://google.aip.dev/134.

Overloads 
def update_mirroring_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_endpoint_group_association via a request object, either of type UpdateMirroringEndpointGroupAssociationRequest or an equivalent Hash.
Parameters 
def update_mirroring_endpoint_group_association(update_mask: nil, mirroring_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_mirroring_endpoint_group_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) — Optional. The list of fields to update. Fields are specified relative to the association (e.g. description; not mirroring_endpoint_group_association.description). See https://google.aip.dev/161 for more details.
  • mirroring_endpoint_group_association (::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation, ::Hash) — Required. The association to update.
  • request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.
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::Mirroring::Client.new

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

# Call the update_mirroring_endpoint_group_association method.
result = client.update_mirroring_endpoint_group_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