Reference documentation and code samples for the Network Management API module Google::Cloud::NetworkManagement.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-network_management library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.network_management)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
Create a new client object for ReachabilityService.
By default, this returns an instance of
Google::Cloud::NetworkManagement::V1::ReachabilityService::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the ReachabilityService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the ReachabilityService service.
You can determine whether the method will succeed by calling
NetworkManagement.reachability_service_available?.
About ReachabilityService
The Reachability service in the Google Cloud Network Management API provides
services that analyze the reachability within a single Google Virtual Private
Cloud (VPC) network, between peered VPC networks, between VPC and on-premises
networks, or between VPC networks and internet hosts. A reachability analysis
is based on Google Cloud network configurations.
You can use the analysis results to verify these configurations and
to troubleshoot connectivity issues.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(::Object) — A client object for the specified version.
Determines whether the ReachabilityService service is supported by the current client.
If true, you can retrieve a client object by calling NetworkManagement.reachability_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the ReachabilityService service,
or if the versioned client gem needs an update to support the ReachabilityService service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Create a new client object for VpcFlowLogsService.
By default, this returns an instance of
Google::Cloud::NetworkManagement::V1::VpcFlowLogsService::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the VpcFlowLogsService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the VpcFlowLogsService service.
You can determine whether the method will succeed by calling
NetworkManagement.vpc_flow_logs_service_available?.
About VpcFlowLogsService
The VPC Flow Logs service in the Google Cloud Network Management API provides
configurations that generate Flow Logs. The service and the configuration
resources created using this service are global.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(::Object) — A client object for the specified version.
Determines whether the VpcFlowLogsService service is supported by the current client.
If true, you can retrieve a client object by calling NetworkManagement.vpc_flow_logs_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the VpcFlowLogsService service,
or if the versioned client gem needs an update to support the VpcFlowLogsService service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Network Management API - Module Google::Cloud::NetworkManagement (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-network_management/latest/Google-Cloud-NetworkManagement)\n- [2.0.0](/ruby/docs/reference/google-cloud-network_management/2.0.0/Google-Cloud-NetworkManagement)\n- [1.5.0](/ruby/docs/reference/google-cloud-network_management/1.5.0/Google-Cloud-NetworkManagement)\n- [1.4.1](/ruby/docs/reference/google-cloud-network_management/1.4.1/Google-Cloud-NetworkManagement)\n- [1.3.0](/ruby/docs/reference/google-cloud-network_management/1.3.0/Google-Cloud-NetworkManagement)\n- [1.2.0](/ruby/docs/reference/google-cloud-network_management/1.2.0/Google-Cloud-NetworkManagement)\n- [1.1.0](/ruby/docs/reference/google-cloud-network_management/1.1.0/Google-Cloud-NetworkManagement)\n- [1.0.1](/ruby/docs/reference/google-cloud-network_management/1.0.1/Google-Cloud-NetworkManagement) \nReference documentation and code samples for the Network Management API module Google::Cloud::NetworkManagement.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-network_management library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.network_management) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .reachability_service\n\n def self.reachability_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for ReachabilityService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::NetworkManagement::V1::ReachabilityService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-network_management-v1/latest/Google-Cloud-NetworkManagement-V1-ReachabilityService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the ReachabilityService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the ReachabilityService service.\nYou can determine whether the method will succeed by calling\n[NetworkManagement.reachability_service_available?](/ruby/docs/reference/google-cloud-network_management/latest/Google-Cloud-NetworkManagement#Google__Cloud__NetworkManagement_reachability_service_available__class_ \"Google::Cloud::NetworkManagement.reachability_service_available? (method)\").\n\n#### About ReachabilityService\n\nThe Reachability service in the Google Cloud Network Management API provides\nservices that analyze the reachability within a single Google Virtual Private\nCloud (VPC) network, between peered VPC networks, between VPC and on-premises\nnetworks, or between VPC networks and internet hosts. A reachability analysis\nis based on Google Cloud network configurations.\n\n\u003cbr /\u003e\n\nYou can use the analysis results to verify these configurations and\nto troubleshoot connectivity issues. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .reachability_service_available?\n\n def self.reachability_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the ReachabilityService service is supported by the current client.\nIf true, you can retrieve a client object by calling [NetworkManagement.reachability_service](/ruby/docs/reference/google-cloud-network_management/latest/Google-Cloud-NetworkManagement#Google__Cloud__NetworkManagement_reachability_service_class_ \"Google::Cloud::NetworkManagement.reachability_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the ReachabilityService service,\nor if the versioned client gem needs an update to support the ReachabilityService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .vpc_flow_logs_service\n\n def self.vpc_flow_logs_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for VpcFlowLogsService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::NetworkManagement::V1::VpcFlowLogsService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-network_management-v1/latest/Google-Cloud-NetworkManagement-V1-VpcFlowLogsService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the VpcFlowLogsService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the VpcFlowLogsService service.\nYou can determine whether the method will succeed by calling\n[NetworkManagement.vpc_flow_logs_service_available?](/ruby/docs/reference/google-cloud-network_management/latest/Google-Cloud-NetworkManagement#Google__Cloud__NetworkManagement_vpc_flow_logs_service_available__class_ \"Google::Cloud::NetworkManagement.vpc_flow_logs_service_available? (method)\").\n\n#### About VpcFlowLogsService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe VPC Flow Logs service in the Google Cloud Network Management API provides\nconfigurations that generate Flow Logs. The service and the configuration\nresources created using this service are global. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .vpc_flow_logs_service_available?\n\n def self.vpc_flow_logs_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the VpcFlowLogsService service is supported by the current client.\nIf true, you can retrieve a client object by calling [NetworkManagement.vpc_flow_logs_service](/ruby/docs/reference/google-cloud-network_management/latest/Google-Cloud-NetworkManagement#Google__Cloud__NetworkManagement_vpc_flow_logs_service_class_ \"Google::Cloud::NetworkManagement.vpc_flow_logs_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the VpcFlowLogsService service,\nor if the versioned client gem needs an update to support the VpcFlowLogsService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]