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

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

Client for the Intercept service.

Service for Third-Party Packet Intercept (TPPI). TPPI is the "in-band" flavor of the Network Security Integrations product.

Inherits

Object

Includes

Google::Cloud::NetworkSecurity::V1::Intercept::Paths

Methods

.configure

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

Configure the Intercept Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#configure

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

Configure the Intercept Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_intercept_deployment

def create_intercept_deployment(request, options = nil) -> ::Gapic::Operation
def create_intercept_deployment(parent: nil, intercept_deployment_id: nil, intercept_deployment: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def create_intercept_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_intercept_deployment via a request object, either of type CreateInterceptDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::CreateInterceptDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_intercept_deployment(parent: nil, intercept_deployment_id: nil, intercept_deployment: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_intercept_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location}
intercept_deployment_id (::String) — Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name.
intercept_deployment (::Google::Cloud::NetworkSecurity::V1::InterceptDeployment, ::Hash) — Required. The deployment to create.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#create_intercept_deployment_group

def create_intercept_deployment_group(request, options = nil) -> ::Gapic::Operation
def create_intercept_deployment_group(parent: nil, intercept_deployment_group_id: nil, intercept_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def create_intercept_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_intercept_deployment_group via a request object, either of type CreateInterceptDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::CreateInterceptDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_intercept_deployment_group(parent: nil, intercept_deployment_group_id: nil, intercept_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_intercept_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location}
intercept_deployment_group_id (::String) — Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name.
intercept_deployment_group (::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup, ::Hash) — Required. The deployment group to create.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#create_intercept_endpoint_group

def create_intercept_endpoint_group(request, options = nil) -> ::Gapic::Operation
def create_intercept_endpoint_group(parent: nil, intercept_endpoint_group_id: nil, intercept_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def create_intercept_endpoint_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_intercept_endpoint_group via a request object, either of type CreateInterceptEndpointGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::CreateInterceptEndpointGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_intercept_endpoint_group(parent: nil, intercept_endpoint_group_id: nil, intercept_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_intercept_endpoint_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location}
intercept_endpoint_group_id (::String) — Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name.
intercept_endpoint_group (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup, ::Hash) — Required. The endpoint group to create.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#create_intercept_endpoint_group_association

def create_intercept_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
def create_intercept_endpoint_group_association(parent: nil, intercept_endpoint_group_association_id: nil, intercept_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def create_intercept_endpoint_group_association(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_intercept_endpoint_group_association via a request object, either of type CreateInterceptEndpointGroupAssociationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::CreateInterceptEndpointGroupAssociationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_intercept_endpoint_group_association(parent: nil, intercept_endpoint_group_association_id: nil, intercept_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_intercept_endpoint_group_association via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location}
intercept_endpoint_group_association_id (::String) — Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID.
intercept_endpoint_group_association (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation, ::Hash) — Required. The association to create.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#delete_intercept_deployment

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

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

Overloads

def delete_intercept_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_deployment via a request object, either of type DeleteInterceptDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::DeleteInterceptDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_intercept_deployment(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Name of the resource
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#delete_intercept_deployment_group

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

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

Overloads

def delete_intercept_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_deployment_group via a request object, either of type DeleteInterceptDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::DeleteInterceptDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_intercept_deployment_group(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The deployment group to delete.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#delete_intercept_endpoint_group

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

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

Overloads

def delete_intercept_endpoint_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_endpoint_group via a request object, either of type DeleteInterceptEndpointGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::DeleteInterceptEndpointGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_intercept_endpoint_group(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_endpoint_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The endpoint group to delete.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#delete_intercept_endpoint_group_association

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

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

Overloads

def delete_intercept_endpoint_group_association(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_endpoint_group_association via a request object, either of type DeleteInterceptEndpointGroupAssociationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::DeleteInterceptEndpointGroupAssociationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_intercept_endpoint_group_association(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_intercept_endpoint_group_association via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. The association to delete.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#get_intercept_deployment

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

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

Overloads

def get_intercept_deployment(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptDeployment

Pass arguments to get_intercept_deployment via a request object, either of type GetInterceptDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::GetInterceptDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_intercept_deployment(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptDeployment

Pass arguments to get_intercept_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetworkSecurity::V1::InterceptDeployment)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetworkSecurity::V1::InterceptDeployment)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#get_intercept_deployment_group

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

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

Overloads

def get_intercept_deployment_group(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup

Pass arguments to get_intercept_deployment_group via a request object, either of type GetInterceptDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::GetInterceptDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_intercept_deployment_group(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup

Pass arguments to get_intercept_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#get_intercept_endpoint_group

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

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

Overloads

def get_intercept_endpoint_group(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup

Pass arguments to get_intercept_endpoint_group via a request object, either of type GetInterceptEndpointGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::GetInterceptEndpointGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_intercept_endpoint_group(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup

Pass arguments to get_intercept_endpoint_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#get_intercept_endpoint_group_association

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

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

Overloads

def get_intercept_endpoint_group_association(request, options = nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation

Pass arguments to get_intercept_endpoint_group_association via a request object, either of type GetInterceptEndpointGroupAssociationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::GetInterceptEndpointGroupAssociationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_intercept_endpoint_group_association(name: nil) -> ::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation

Pass arguments to get_intercept_endpoint_group_association via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#iam_policy_client

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

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

Returns

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

#initialize

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

Create a new Intercept client object.

Yields

(config) — Configure the Intercept client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::NetworkSecurity::V1::Intercept::Client.new

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

#list_intercept_deployment_groups

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

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

Overloads

def list_intercept_deployment_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup>

Pass arguments to list_intercept_deployment_groups via a request object, either of type ListInterceptDeploymentGroupsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::ListInterceptDeploymentGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_intercept_deployment_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup>

Pass arguments to list_intercept_deployment_groups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of deployment groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
page_token (::String) — Optional. A page token, received from a previous ListInterceptDeploymentGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInterceptDeploymentGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

#list_intercept_deployments

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

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

Overloads

def list_intercept_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeployment>

Pass arguments to list_intercept_deployments via a request object, either of type ListInterceptDeploymentsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::ListInterceptDeploymentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_intercept_deployments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeployment>

Pass arguments to list_intercept_deployments via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of deployments. Example: projects/123456789/locations/us-central1-a. See https://google.aip.dev/132 for more details.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
page_token (::String) — Optional. A page token, received from a previous ListInterceptDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInterceptDeployments must match the call that provided the page token. See https://google.aip.dev/158 for more details.
filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeployment>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptDeployment>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

#list_intercept_endpoint_group_associations

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

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

Overloads

def list_intercept_endpoint_group_associations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation>

Pass arguments to list_intercept_endpoint_group_associations via a request object, either of type ListInterceptEndpointGroupAssociationsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::ListInterceptEndpointGroupAssociationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_intercept_endpoint_group_associations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation>

Pass arguments to list_intercept_endpoint_group_associations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of associations. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
page_token (::String) — Optional. A page token, received from a previous ListInterceptEndpointGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInterceptEndpointGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

#list_intercept_endpoint_groups

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

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

Overloads

def list_intercept_endpoint_groups(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup>

Pass arguments to list_intercept_endpoint_groups via a request object, either of type ListInterceptEndpointGroupsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::ListInterceptEndpointGroupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_intercept_endpoint_groups(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup>

Pass arguments to list_intercept_endpoint_groups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. The parent, which owns this collection of endpoint groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details.
page_size (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. See https://google.aip.dev/158 for more details.
page_token (::String) — Optional. A page token, received from a previous ListInterceptEndpointGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInterceptEndpointGroups must match the call that provided the page token. See https://google.aip.dev/158 for more details.
filter (::String) — Optional. Filter expression. See https://google.aip.dev/160#filtering for more details.
order_by (::String) — Optional. Sort expression. See https://google.aip.dev/132#ordering for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

#location_client

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

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

Returns

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

(Logger)

#operations_client

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

Get the associated client for long-running operations.

Returns

(::Google::Cloud::NetworkSecurity::V1::Intercept::Operations)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_intercept_deployment

def update_intercept_deployment(request, options = nil) -> ::Gapic::Operation
def update_intercept_deployment(update_mask: nil, intercept_deployment: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def update_intercept_deployment(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_intercept_deployment via a request object, either of type UpdateInterceptDeploymentRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::UpdateInterceptDeploymentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_intercept_deployment(update_mask: nil, intercept_deployment: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_intercept_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. description; not intercept_deployment.description). See https://google.aip.dev/161 for more details.
intercept_deployment (::Google::Cloud::NetworkSecurity::V1::InterceptDeployment, ::Hash) — Required. The deployment to update.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#update_intercept_deployment_group

def update_intercept_deployment_group(request, options = nil) -> ::Gapic::Operation
def update_intercept_deployment_group(update_mask: nil, intercept_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def update_intercept_deployment_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_intercept_deployment_group via a request object, either of type UpdateInterceptDeploymentGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::UpdateInterceptDeploymentGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_intercept_deployment_group(update_mask: nil, intercept_deployment_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_intercept_deployment_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. description; not intercept_deployment_group.description). See https://google.aip.dev/161 for more details.
intercept_deployment_group (::Google::Cloud::NetworkSecurity::V1::InterceptDeploymentGroup, ::Hash) — Required. The deployment group to update.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#update_intercept_endpoint_group

def update_intercept_endpoint_group(request, options = nil) -> ::Gapic::Operation
def update_intercept_endpoint_group(update_mask: nil, intercept_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def update_intercept_endpoint_group(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_intercept_endpoint_group via a request object, either of type UpdateInterceptEndpointGroupRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::UpdateInterceptEndpointGroupRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_intercept_endpoint_group(update_mask: nil, intercept_endpoint_group: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_intercept_endpoint_group via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. description; not intercept_endpoint_group.description). See https://google.aip.dev/161 for more details.
intercept_endpoint_group (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroup, ::Hash) — Required. The endpoint group to update.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

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

#update_intercept_endpoint_group_association

def update_intercept_endpoint_group_association(request, options = nil) -> ::Gapic::Operation
def update_intercept_endpoint_group_association(update_mask: nil, intercept_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

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

Overloads

def update_intercept_endpoint_group_association(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_intercept_endpoint_group_association via a request object, either of type UpdateInterceptEndpointGroupAssociationRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::NetworkSecurity::V1::UpdateInterceptEndpointGroupAssociationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_intercept_endpoint_group_association(update_mask: nil, intercept_endpoint_group_association: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_intercept_endpoint_group_association via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. Fields are specified relative to the association (e.g. description; not intercept_endpoint_group_association.description). See https://google.aip.dev/161 for more details.
intercept_endpoint_group_association (::Google::Cloud::NetworkSecurity::V1::InterceptEndpointGroupAssociation, ::Hash) — Required. The association to update.
request_id (::String) — Optional. A unique identifier for this request. Must be a UUID4. This request is only idempotent if a request_id is provided. See https://google.aip.dev/155 for more details.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/network_security/v1"

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

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

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

Network Security V1 API - Class Google::Cloud::NetworkSecurity::V1::Intercept::Client (v0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Inherits

Includes

Methods

.configure

#configure

#create_intercept_deployment

#create_intercept_deployment_group

#create_intercept_endpoint_group

#create_intercept_endpoint_group_association

#delete_intercept_deployment

#delete_intercept_deployment_group

#delete_intercept_endpoint_group

#delete_intercept_endpoint_group_association

#get_intercept_deployment

#get_intercept_deployment_group

#get_intercept_endpoint_group

#get_intercept_endpoint_group_association

#iam_policy_client

#initialize

#list_intercept_deployment_groups

#list_intercept_deployments

#list_intercept_endpoint_group_associations

#list_intercept_endpoint_groups

#location_client

#logger

#operations_client

#universe_domain

#update_intercept_deployment

#update_intercept_deployment_group

#update_intercept_endpoint_group

#update_intercept_endpoint_group_association

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