google-cloud-network_connectivity-v1beta 0.a → 0.1.0

data/proto_docs/google/cloud/networkconnectivity/v1beta/transport_manager.rb

@@ -0,0 +1,621 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module NetworkConnectivity
+      module V1beta
+        # Message describing RemoteTransportProfile object.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Name of the resource in the format of $provider-$site.
+        # @!attribute [r] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Output only. Labels as key value pairs.
+        # @!attribute [r] description
+        #   @return [::String]
+        #     Output only. Description of the profile.
+        # @!attribute [r] provider
+        #   @return [::String]
+        #     Output only. Name of the provider on the other end of this profile. E.g.
+        #     “Amazon Web Services” or “Microsoft Azure”.
+        # @!attribute [r] provider_site
+        #   @return [::String]
+        #     Output only. If the profile is a Cloud Service Provider with compute
+        #     resources, this is populated with the region where connectivity is being
+        #     established. If the profile provides facility-level selection, this is an
+        #     identity of the facility any connections on this profile are going through.
+        # @!attribute [r] supported_bandwidths
+        #   @return [::Array<::Google::Cloud::NetworkConnectivity::V1beta::RemoteTransportProfile::Bandwidth>]
+        #     Output only. List of bandwidth enum values that are supported by this
+        #     profile.
+        # @!attribute [r] sla
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::RemoteTransportProfile::ServiceLevelAvailability]
+        #     Output only. Availability class that will be configured for this
+        #     particular RemoteTransportProfile.
+        # @!attribute [r] flow
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::RemoteTransportProfile::KeyProvisioningFlow]
+        #     Output only. Type of provisioning flows supported by this profile.
+        # @!attribute [r] order_state
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::RemoteTransportProfile::State]
+        #     Output only. Order state for this profile.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. Human readable name of this profile, used to identify this
+        #     profile in the UI.
+        class RemoteTransportProfile
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Bandwidth values that may be supported for a specific profile.
+          module Bandwidth
+            # Unspecified bandwidth.
+            BANDWIDTH_UNSPECIFIED = 0
+
+            # 50 Megabits per second.
+            BPS_50M = 1
+
+            # 100 Megabits per second.
+            BPS_100M = 2
+
+            # 200 Megabits per second.
+            BPS_200M = 3
+
+            # 300 Megabits per second.
+            BPS_300M = 4
+
+            # 400 Megabits per second.
+            BPS_400M = 5
+
+            # 500 Megabits per second.
+            BPS_500M = 6
+
+            # 1 Gigabit per second.
+            BPS_1G = 7
+
+            # 2 Gigabits per second.
+            BPS_2G = 8
+
+            # 5 Gigabits per second.
+            BPS_5G = 9
+
+            # 10 Gigabits per second.
+            BPS_10G = 10
+
+            # 20 Gigabits per second.
+            BPS_20G = 11
+
+            # 50 Gigabits per second.
+            BPS_50G = 12
+
+            # 100 Gigabits per second.
+            BPS_100G = 13
+          end
+
+          # Availability class options.
+          module ServiceLevelAvailability
+            # Unspecified service level availability.
+            SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED = 0
+
+            # This represents a 99.9% service level on the availability of the
+            # configured connectivity.
+            HIGH = 1
+
+            # This represents a 99.99% service level on the availability of the
+            # configured connectivity.
+            MAXIMUM = 2
+          end
+
+          # Type of provisioning flows supported.
+          module KeyProvisioningFlow
+            # Unspecified key provisioning flow.
+            KEY_PROVISIONING_FLOW_UNSPECIFIED = 0
+
+            # The activationKey field on the Transport must be included in a create or
+            # patch request to establish connectivity.
+            INPUT_ONLY = 1
+
+            # The generatedActivationKey field is populated and must be read from the
+            # resource and passed into the other provider.
+            OUTPUT_ONLY = 2
+
+            # Both activation key fields are allowed for establishing connectivity. If
+            # a key is input, the generated key is still present after provisioning is
+            # finished.
+            INPUT_OR_OUTPUT = 3
+          end
+
+          # State of the RemoteTransportProfile.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # Not enough capacity for customers to order.
+            CLOSED = 1
+
+            # Enough capacity to fulfill an order.
+            OPEN = 2
+          end
+        end
+
+        # Message for requesting list of RemoteTransportProfiles.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent value for ListRemoteTransportProfilesRequest.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server may return fewer items than
+        #     requested. If unspecified, server will pick an appropriate default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results the server should return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filtering results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Hint for how to order the results.
+        class ListRemoteTransportProfilesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for response to listing RemoteTransportProfiles
+        # @!attribute [rw] remote_transport_profiles
+        #   @return [::Array<::Google::Cloud::NetworkConnectivity::V1beta::RemoteTransportProfile>]
+        #     The list of RemoteTransportProfiles.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unordered list. Locations that could not be reached.
+        class ListRemoteTransportProfilesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for getting a RemoteTransportProfile.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        class GetRemoteTransportProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing Transport object.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Name of the resource.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time stamp.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time stamp.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels as key value pairs.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Description of the Transport.
+        # @!attribute [rw] remote_profile
+        #   @return [::String]
+        #     Optional. Name of the remoteTransportProfile that this Transport is
+        #     connecting to.
+        # @!attribute [rw] provided_activation_key
+        #   @return [::String]
+        #     Optional. Key used for establishing a connection with the remote transport.
+        #     This key can only be provided if the profile supports an INPUT key flow and
+        #     the resource is in the PENDING_KEY state.
+        # @!attribute [r] generated_activation_key
+        #   @return [::String]
+        #     Output only. Google-generated activation key. This is only output if the
+        #     selected profile supports an OUTPUT key flow. Inputting this to the
+        #     provider is only valid while the resource is in a PENDING_KEY state. Once
+        #     the provider has accepted the key, the resource will move to the
+        #     CONFIGURING state.
+        # @!attribute [rw] bandwidth
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::Transport::Bandwidth]
+        #     Optional. Bandwidth of the Transport. This must be one of the supported
+        #     bandwidths for the remote profile, and must be set when no activation key
+        #     is being provided.
+        # @!attribute [rw] stack_type
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::Transport::StackType]
+        #     Optional. IP version stack for the established connectivity.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::Transport::State]
+        #     Output only. State of the underlying connectivity.
+        # @!attribute [r] mtu_limit
+        #   @return [::Integer]
+        #     Output only. The maximum transmission unit (MTU) of a packet that can be
+        #     sent over this transport.
+        # @!attribute [rw] admin_enabled
+        #   @return [::Boolean]
+        #     Optional. Administrative state of the underlying connectivity. If set to
+        #     true (default), connectivity should be available between your environments.
+        #     If set to false, the connectivity over these links is disabled. Disabling
+        #     your Transport does not affect billing, and retains the underlying network
+        #     bandwidth associated with the connectivity.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Optional. Resource URI of the Network that will be peered with this
+        #     Transport. This field must be provided during resource creation and cannot
+        #     be changed.
+        # @!attribute [rw] advertised_routes
+        #   @return [::Array<::String>]
+        #     Optional. List of IP Prefixes that will be advertised to the remote
+        #     provider. Both IPv4 and IPv6 addresses are supported.
+        # @!attribute [rw] remote_account_id
+        #   @return [::String]
+        #     Optional. The user supplied account id for the CSP associated with the
+        #     remote profile.
+        # @!attribute [r] peering_network
+        #   @return [::String]
+        #     Output only. VPC Network URI that was created for the VPC Peering
+        #     connection to the provided `network`. If VPC Peering is disconnected, this
+        #     can be used to re-establish.
+        class Transport
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Supported bandwidth options.
+          module Bandwidth
+            # Unspecified bandwidth.
+            BANDWIDTH_UNSPECIFIED = 0
+
+            # 50 Megabits per second.
+            BPS_50M = 1
+
+            # 100 Megabits per second.
+            BPS_100M = 2
+
+            # 200 Megabits per second.
+            BPS_200M = 3
+
+            # 300 Megabits per second.
+            BPS_300M = 4
+
+            # 400 Megabits per second.
+            BPS_400M = 5
+
+            # 500 Megabits per second.
+            BPS_500M = 6
+
+            # 1 Gigabit per second.
+            BPS_1G = 7
+
+            # 2 Gigabits per second.
+            BPS_2G = 8
+
+            # 5 Gigabits per second.
+            BPS_5G = 9
+
+            # 10 Gigabits per second.
+            BPS_10G = 10
+
+            # 20 Gigabits per second.
+            BPS_20G = 11
+
+            # 50 Gigabits per second.
+            BPS_50G = 12
+
+            # 100 Gigabits per second.
+            BPS_100G = 13
+          end
+
+          # IP version stack for the established connectivity.
+          module StackType
+            # Unspecified stack type.
+            STACK_TYPE_UNSPECIFIED = 0
+
+            # Only IPv4 is supported. (default)
+            IPV4_ONLY = 1
+
+            # Both IPv4 and IPv6 are supported.
+            IPV4_IPV6 = 2
+          end
+
+          # Represents the status of the underlying connectivity. One of
+          # the following states, depending on who has initiated the Transport request.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The resource exists locally and is being created / associated with the
+            # resource on the remote provider’s end of the underlying connectivity.
+            CREATING = 1
+
+            # The Transport exists on both sides of the connection, and is waiting for
+            # configuration to finalize and be verified as operational.
+            PENDING_CONFIG = 2
+
+            # The Transport was created in GCP. Depending on the profile’s key
+            # provisioning flow, this is either waiting for an activation key to be
+            # input (the key will be validated that it uses remote resources that match
+            # the Transport), or for the generated key to be input to the provider for
+            # finalizing. The configured bandwidth is not yet guaranteed.
+            PENDING_KEY = 3
+
+            # The Transport is configured and the underlying connectivity is considered
+            # operational.
+            ACTIVE = 4
+
+            # The Transport is being deleted from GCP. The underlying connectivity is
+            # no longer operational.
+            DELETING = 5
+
+            # The Transport was deleted on the remote provider's end and is no longer
+            # operational. GCP has insufficient information to move the resource back
+            # to PENDING_KEY state.
+            DEPROVISIONED = 6
+          end
+        end
+
+        # Message for requesting list of Transports.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent value for ListTransportsRequest.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server may return fewer items than
+        #     requested. If unspecified, server will pick an appropriate default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results the server should return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filtering results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Hint for how to order the results.
+        class ListTransportsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for response to listing Transports.
+        # @!attribute [rw] transports
+        #   @return [::Array<::Google::Cloud::NetworkConnectivity::V1beta::Transport>]
+        #     The list of Transport.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unordered list. Locations that could not be reached.
+        class ListTransportsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for getting a Transport.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        class GetTransportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for getting a Transport's operational status.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        class GetStatusRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for the response to getting a Transport's operational status.
+        # @!attribute [rw] overall_status
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::GetStatusResponse::OverallStatus]
+        #     The overall status of the Transport. This field will always output the most
+        #     critical status of the Transport. For example, if the connectivity is
+        #     DISCONNECTED, and the underlying networking components are DOWN, then
+        #     the overall status will be DOWN.
+        # @!attribute [rw] operational_status
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::GetStatusResponse::OperationalStatus]
+        #     The operational status of the underlying networking components.
+        # @!attribute [rw] connectivity_status
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::GetStatusResponse::ConnectivityStatus]
+        #     Current status of connectivity to the local GCP resource. This reflects
+        #     whether the VPC Peering or NCC Hub appears correctly configured.
+        # @!attribute [rw] mac_sec_status
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::GetStatusResponse::MacSecStatus]
+        #     Current status of MACSec on the underlying network connectivity between GC
+        #     and the partner.
+        class GetStatusResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The overall status of the Transport.
+          module OverallStatus
+            # Unspecified status.
+            OVERALL_STATUS_UNSPECIFIED = 0
+
+            # Resource is active and operational.
+            ACTIVE = 1
+
+            # Resource is waiting for an activation key to be exchanged.
+            PENDING_KEY = 2
+
+            # Activation keys have been exchanged and connectivity is being
+            # established.
+            CONFIGURING = 3
+
+            # VPC Peering has been taken down, or the NCC Spoke has been rejected.
+            DISCONNECTED = 4
+
+            # User configuration is correct, but the configured capacity is
+            # operationally down.
+            DOWN = 5
+          end
+
+          # The operational status of the underlying networking components.
+          module OperationalStatus
+            # Unspecified status.
+            OPERATIONAL_STATUS_UNSPECIFIED = 0
+
+            # Protected capacity is available and networking components show as up.
+            OPERATIONAL_STATUS_ACTIVE = 1
+
+            # Protected capacity is showing as operationally down.
+            OPERATIONAL_STATUS_DOWN = 2
+          end
+
+          # Current status of connectivity to the local GCP resource. This reflects
+          # whether the VPC Peering or NCC Hub appears correctly configured.
+          module ConnectivityStatus
+            # Unspecified status.
+            CONNECTIVITY_STATUS_UNSPECIFIED = 0
+
+            # VPC Peering or the NCC Hub appear to be correctly established.
+            CONNECTIVITY_STATUS_CONNECTED = 1
+
+            # VPC Peering has been taken down, or the NCC Spoke has been rejected.
+            CONNECTIVITY_STATUS_DISCONNECTED = 2
+          end
+
+          # Current status of MACSec on the underlying network connectivity between GC
+          # and the partner.
+          module MacSecStatus
+            # Unspecified status.
+            MAC_SEC_STATUS_UNSPECIFIED = 0
+
+            # MACSec is protecting the links and configured in fail closed.
+            MAC_SEC_STATUS_ACTIVE_FAIL_CLOSED = 1
+
+            # MACSec is protecting the links and configured to fail open on at least
+            # one of the redundant links.
+            MAC_SEC_STATUS_ACTIVE_FAIL_OPEN = 2
+
+            # MACSec is not configured on at least one of the underlying links.
+            MAC_SEC_STATUS_NOT_CONFIGURED = 3
+          end
+        end
+
+        # Message for creating a Transport
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Value for parent.
+        # @!attribute [rw] transport_id
+        #   @return [::String]
+        #     Required. Id of the requesting object
+        # @!attribute [rw] transport
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::Transport]
+        #     Required. The resource being created
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes since the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class CreateTransportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for updating a Transport.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask is used to specify the fields to be overwritten in the
+        #     Transport resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. If the
+        #     user does not provide a mask then all fields present in the request will be
+        #     overwritten.
+        # @!attribute [rw] transport
+        #   @return [::Google::Cloud::NetworkConnectivity::V1beta::Transport]
+        #     Required. The resource being updated.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes since the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class UpdateTransportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for deleting a Transport.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes after the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class DeleteTransportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end