Class: Google::Cloud::NetworkSecurity::V1::Mirroring::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/network_security/v1/mirroring/client.rb

Overview

Client for the Mirroring service.

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

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#forwarding_rule_path, #location_path, #mirroring_deployment_group_path, #mirroring_deployment_path, #mirroring_endpoint_group_association_path, #mirroring_endpoint_group_path, #network_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Mirroring client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the Mirroring client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 126

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/networksecurity/v1/mirroring_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @mirroring_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::NetworkSecurity::V1::Mirroring::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @mirroring_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @mirroring_stub.endpoint
    config.universe_domain = @mirroring_stub.universe_domain
    config.logger = @mirroring_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @mirroring_stub.endpoint
    config.universe_domain = @mirroring_stub.universe_domain
    config.logger = @mirroring_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

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

Returns:

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


219
220
221
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 219

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


212
213
214
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 212

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::NetworkSecurity::V1::Mirroring::Operations (readonly)

Get the associated client for long-running operations.

Returns:



205
206
207
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 205

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Mirroring Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Mirroring clients
::Google::Cloud::NetworkSecurity::V1::Mirroring::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "NetworkSecurity", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_mirroring_deployment(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}

    • mirroring_deployment_id (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The deployment to create.

    • request_id (::String) (defaults to: nil) —

      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.



2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 2014

def create_mirroring_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::CreateMirroringDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_mirroring_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_mirroring_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_mirroring_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :create_mirroring_deployment, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_mirroring_deployment_group(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}

    • mirroring_deployment_group_id (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The deployment group to create.

    • request_id (::String) (defaults to: nil) —

      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.



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1507

def create_mirroring_deployment_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::CreateMirroringDeploymentGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_mirroring_deployment_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_mirroring_deployment_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_mirroring_deployment_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :create_mirroring_deployment_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_mirroring_endpoint_group(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}

    • mirroring_endpoint_group_id (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The endpoint group to create.

    • request_id (::String) (defaults to: nil) —

      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.



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 493

def create_mirroring_endpoint_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::CreateMirroringEndpointGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_mirroring_endpoint_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_mirroring_endpoint_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_mirroring_endpoint_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :create_mirroring_endpoint_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_mirroring_endpoint_group_association(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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:

  • #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) (defaults to: nil) —

      Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}

    • mirroring_endpoint_group_association_id (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The association to create.

    • request_id (::String) (defaults to: nil) —

      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.



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1000

def create_mirroring_endpoint_group_association request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::CreateMirroringEndpointGroupAssociationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_mirroring_endpoint_group_association.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_mirroring_endpoint_group_association.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_mirroring_endpoint_group_association.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :create_mirroring_endpoint_group_association, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_mirroring_deployment(request, options = nil) ⇒ ::Gapic::Operation #delete_mirroring_deployment(name: nil, request_id: nil) ⇒ ::Gapic::Operation

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. Name of the resource

    • request_id (::String) (defaults to: nil) —

      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.



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 2217

def delete_mirroring_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::DeleteMirroringDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_mirroring_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_mirroring_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_mirroring_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :delete_mirroring_deployment, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_mirroring_deployment_group(request, options = nil) ⇒ ::Gapic::Operation #delete_mirroring_deployment_group(name: nil, request_id: nil) ⇒ ::Gapic::Operation

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The deployment group to delete.

    • request_id (::String) (defaults to: nil) —

      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.



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1711

def delete_mirroring_deployment_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::DeleteMirroringDeploymentGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_mirroring_deployment_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_mirroring_deployment_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_mirroring_deployment_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :delete_mirroring_deployment_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_mirroring_endpoint_group(request, options = nil) ⇒ ::Gapic::Operation #delete_mirroring_endpoint_group(name: nil, request_id: nil) ⇒ ::Gapic::Operation

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      Required. The endpoint group to delete.

    • request_id (::String) (defaults to: nil) —

      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.



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 696

def delete_mirroring_endpoint_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::DeleteMirroringEndpointGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_mirroring_endpoint_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_mirroring_endpoint_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_mirroring_endpoint_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :delete_mirroring_endpoint_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_mirroring_endpoint_group_association(request, options = nil) ⇒ ::Gapic::Operation #delete_mirroring_endpoint_group_association(name: nil, request_id: nil) ⇒ ::Gapic::Operation

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

Examples:

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

Overloads:

  • #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:

  • #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) (defaults to: nil) —

      Required. The association to delete.

    • request_id (::String) (defaults to: nil) —

      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.



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1204

def delete_mirroring_endpoint_group_association request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::DeleteMirroringEndpointGroupAssociationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_mirroring_endpoint_group_association.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_mirroring_endpoint_group_association.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_mirroring_endpoint_group_association.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :delete_mirroring_endpoint_group_association, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_mirroring_deployment(request, options = nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringDeployment #get_mirroring_deployment(name: nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringDeployment

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1911

def get_mirroring_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::GetMirroringDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_mirroring_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_mirroring_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_mirroring_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :get_mirroring_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_mirroring_deployment_group(request, options = nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup #get_mirroring_deployment_group(name: nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1404

def get_mirroring_deployment_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::GetMirroringDeploymentGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_mirroring_deployment_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_mirroring_deployment_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_mirroring_deployment_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :get_mirroring_deployment_group, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_mirroring_endpoint_group(request, options = nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup #get_mirroring_endpoint_group(name: nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

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

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 390

def get_mirroring_endpoint_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::GetMirroringEndpointGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_mirroring_endpoint_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_mirroring_endpoint_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_mirroring_endpoint_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :get_mirroring_endpoint_group, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_mirroring_endpoint_group_association(request, options = nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation #get_mirroring_endpoint_group_association(name: nil) ⇒ ::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation

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

Examples:

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

Overloads:

  • #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:

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

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 896

def get_mirroring_endpoint_group_association request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::GetMirroringEndpointGroupAssociationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_mirroring_endpoint_group_association.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_mirroring_endpoint_group_association.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_mirroring_endpoint_group_association.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :get_mirroring_endpoint_group_association, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_mirroring_deployment_groups(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup> #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.

    • order_by (::String) (defaults to: nil) —

      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.



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1314

def list_mirroring_deployment_groups request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::ListMirroringDeploymentGroupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_mirroring_deployment_groups.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_mirroring_deployment_groups.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_mirroring_deployment_groups.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :list_mirroring_deployment_groups, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @mirroring_stub, :list_mirroring_deployment_groups, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_mirroring_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringDeployment> #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.

    • order_by (::String) (defaults to: nil) —

      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.



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1821

def list_mirroring_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::ListMirroringDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_mirroring_deployments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_mirroring_deployments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_mirroring_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :list_mirroring_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @mirroring_stub, :list_mirroring_deployments, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_mirroring_endpoint_group_associations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation> #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.

Examples:

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

Overloads:

  • #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:

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.

    • order_by (::String) (defaults to: nil) —

      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.



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 806

def list_mirroring_endpoint_group_associations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::ListMirroringEndpointGroupAssociationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_mirroring_endpoint_group_associations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_mirroring_endpoint_group_associations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_mirroring_endpoint_group_associations.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :list_mirroring_endpoint_group_associations, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @mirroring_stub, :list_mirroring_endpoint_group_associations, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_mirroring_endpoint_groups(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup> #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.

    • order_by (::String) (defaults to: nil) —

      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.



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 300

def list_mirroring_endpoint_groups request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::ListMirroringEndpointGroupsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_mirroring_endpoint_groups.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_mirroring_endpoint_groups.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_mirroring_endpoint_groups.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :list_mirroring_endpoint_groups, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @mirroring_stub, :list_mirroring_endpoint_groups, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


226
227
228
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 226

def logger
  @mirroring_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 106

def universe_domain
  @mirroring_stub.universe_domain
end

#update_mirroring_deployment(request, options = nil) ⇒ ::Gapic::Operation #update_mirroring_deployment(update_mask: nil, mirroring_deployment: nil, request_id: nil) ⇒ ::Gapic::Operation

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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:

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.



2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 2118

def update_mirroring_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::UpdateMirroringDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_mirroring_deployment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.mirroring_deployment&.name
    header_params["mirroring_deployment.name"] = request.mirroring_deployment.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_mirroring_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_mirroring_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :update_mirroring_deployment, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_mirroring_deployment_group(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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:

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.



1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1612

def update_mirroring_deployment_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::UpdateMirroringDeploymentGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_mirroring_deployment_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.mirroring_deployment_group&.name
    header_params["mirroring_deployment_group.name"] = request.mirroring_deployment_group.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_mirroring_deployment_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_mirroring_deployment_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :update_mirroring_deployment_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_mirroring_endpoint_group(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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:

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.



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 597

def update_mirroring_endpoint_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::UpdateMirroringEndpointGroupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_mirroring_endpoint_group.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.mirroring_endpoint_group&.name
    header_params["mirroring_endpoint_group.name"] = request.mirroring_endpoint_group.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_mirroring_endpoint_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_mirroring_endpoint_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :update_mirroring_endpoint_group, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_mirroring_endpoint_group_association(request, options = nil) ⇒ ::Gapic::Operation #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.

Examples:

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

Overloads:

  • #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:

  • #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:

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.



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/cloud/network_security/v1/mirroring/client.rb', line 1105

def update_mirroring_endpoint_group_association request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1::UpdateMirroringEndpointGroupAssociationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_mirroring_endpoint_group_association.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::NetworkSecurity::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.mirroring_endpoint_group_association&.name
    header_params["mirroring_endpoint_group_association.name"] = request.mirroring_endpoint_group_association.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_mirroring_endpoint_group_association.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_mirroring_endpoint_group_association.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @mirroring_stub.call_rpc :update_mirroring_endpoint_group_association, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end