google-cloud-network_security-v1 0.a → 0.1.0

data/proto_docs/google/cloud/networksecurity/v1/mirroring.rb

@@ -0,0 +1,970 @@
+# 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 NetworkSecurity
+      module V1
+        # An endpoint group is a consumer frontend for a deployment group (backend).
+        # In order to configure mirroring for a network, consumers must create:
+        # - An association between their network and the endpoint group.
+        # - A security profile that points to the endpoint group.
+        # - A mirroring rule that references the security profile (group).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Identifier. The resource name of this endpoint group, for
+        #     example:
+        #     `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`.
+        #     See https://google.aip.dev/122 for more details.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was created.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was most recently updated.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels are key/value pairs that help to organize and filter
+        #     resources.
+        # @!attribute [rw] mirroring_deployment_group
+        #   @return [::String]
+        #     Immutable. The deployment group that this DIRECT endpoint group is
+        #     connected to, for example:
+        #     `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`.
+        #     See https://google.aip.dev/124.
+        # @!attribute [r] connected_deployment_groups
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup::ConnectedDeploymentGroup>]
+        #     Output only. List of details about the connected deployment groups to this
+        #     endpoint group.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup::State]
+        #     Output only. The current state of the endpoint group.
+        #     See https://google.aip.dev/216.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     Output only. The current state of the resource does not match the user's
+        #     intended state, and the system is working to reconcile them. This is part
+        #     of the normal operation (e.g. adding a new association to the group). See
+        #     https://google.aip.dev/128.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup::Type]
+        #     Immutable. The type of the endpoint group.
+        #     If left unspecified, defaults to DIRECT.
+        # @!attribute [r] associations
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup::AssociationDetails>]
+        #     Output only. List of associations to this endpoint group.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description of the endpoint group.
+        #     Used as additional context for the endpoint group.
+        class MirroringEndpointGroup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The endpoint group's view of a connected deployment group.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The connected deployment group's resource name, for example:
+          #     `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`.
+          #     See https://google.aip.dev/124.
+          # @!attribute [r] locations
+          #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringLocation>]
+          #     Output only. The list of locations where the deployment group is present.
+          class ConnectedDeploymentGroup
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The endpoint group's view of a connected association.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The connected association's resource name, for example:
+          #     `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-ega`.
+          #     See https://google.aip.dev/124.
+          # @!attribute [r] network
+          #   @return [::String]
+          #     Output only. The associated network, for example:
+          #     projects/123456789/global/networks/my-network.
+          #     See https://google.aip.dev/124.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation::State]
+          #     Output only. Most recent known state of the association.
+          class AssociationDetails
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The current state of the endpoint group.
+          module State
+            # State not set (this is not a valid state).
+            STATE_UNSPECIFIED = 0
+
+            # The endpoint group is ready and in sync with the target deployment group.
+            ACTIVE = 1
+
+            # The deployment group backing this endpoint group has been force-deleted.
+            # This endpoint group cannot be used and mirroring is effectively disabled.
+            CLOSED = 2
+
+            # The endpoint group is being created.
+            CREATING = 3
+
+            # The endpoint group is being deleted.
+            DELETING = 4
+
+            # The endpoint group is out of sync with the backing deployment group.
+            # In most cases, this is a result of a transient issue within the system
+            # (e.g. an inaccessible location) and the system is expected to recover
+            # automatically. See the associations field for details per network and
+            # location.
+            OUT_OF_SYNC = 5
+
+            # An attempt to delete the endpoint group has failed. This is a terminal
+            # state and the endpoint group is not expected to recover.
+            # The only permitted operation is to retry deleting the endpoint group.
+            DELETE_FAILED = 6
+          end
+
+          # The type of the endpoint group.
+          module Type
+            # Not set.
+            TYPE_UNSPECIFIED = 0
+
+            # An endpoint group that sends packets to a single deployment group.
+            DIRECT = 1
+          end
+        end
+
+        # Request message for ListMirroringEndpointGroups.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!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. See
+        #     https://google.aip.dev/158 for more details.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous
+        #     `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent
+        #     page. When paginating, all other parameters provided to
+        #     `ListMirroringEndpointGroups` must match the call that provided the page
+        #     token.
+        #     See https://google.aip.dev/158 for more details.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression.
+        #     See https://google.aip.dev/160#filtering for more details.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Sort expression.
+        #     See https://google.aip.dev/132#ordering for more details.
+        class ListMirroringEndpointGroupsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListMirroringEndpointGroups.
+        # @!attribute [rw] mirroring_endpoint_groups
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup>]
+        #     The endpoint groups from the specified parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        #     See https://google.aip.dev/158 for more details.
+        class ListMirroringEndpointGroupsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetMirroringEndpointGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the endpoint group to retrieve.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/mirroringEndpointGroups/\\{mirroring_endpoint_group}
+        class GetMirroringEndpointGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for CreateMirroringEndpointGroup.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this endpoint group will be created.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] mirroring_endpoint_group_id
+        #   @return [::String]
+        #     Required. The ID to use for the endpoint group, which will become the final
+        #     component of the endpoint group's resource name.
+        # @!attribute [rw] mirroring_endpoint_group
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup]
+        #     Required. The endpoint group to create.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class CreateMirroringEndpointGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateMirroringEndpointGroup.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        #     Fields are specified relative to the endpoint group
+        #     (e.g. `description`; *not* `mirroring_endpoint_group.description`).
+        #     See https://google.aip.dev/161 for more details.
+        # @!attribute [rw] mirroring_endpoint_group
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroup]
+        #     Required. The endpoint group to update.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class UpdateMirroringEndpointGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for DeleteMirroringEndpointGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The endpoint group to delete.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class DeleteMirroringEndpointGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An endpoint group association represents a link between a network and an
+        # endpoint group in the organization.
+        #
+        # Creating an association creates the networking infrastructure linking the
+        # network to the endpoint group, but does not enable mirroring by itself.
+        # To enable mirroring, the user must also create a network firewall policy
+        # containing mirroring rules and associate it with the network.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Identifier. The resource name of this endpoint group
+        #     association, for example:
+        #     `projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association`.
+        #     See https://google.aip.dev/122 for more details.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was created.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was most recently updated.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels are key/value pairs that help to organize and filter
+        #     resources.
+        # @!attribute [rw] mirroring_endpoint_group
+        #   @return [::String]
+        #     Immutable. The endpoint group that this association is connected to, for
+        #     example:
+        #     `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`.
+        #     See https://google.aip.dev/124.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Immutable. The VPC network that is associated. for example:
+        #     `projects/123456789/global/networks/my-network`.
+        #     See https://google.aip.dev/124.
+        # @!attribute [r] locations_details
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation::LocationDetails>]
+        #     Output only. The list of locations where the association is present. This
+        #     information is retrieved from the linked endpoint group, and not configured
+        #     as part of the association itself.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation::State]
+        #     Output only. Current state of the endpoint group association.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     Output only. The current state of the resource does not match the user's
+        #     intended state, and the system is working to reconcile them. This part of
+        #     the normal operation (e.g. adding a new location to the target deployment
+        #     group). See https://google.aip.dev/128.
+        # @!attribute [r] locations
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringLocation>]
+        #     Output only. The list of locations where the association is configured.
+        #     This information is retrieved from the linked endpoint group.
+        class MirroringEndpointGroupAssociation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains details about the state of an association in a specific cloud
+          # location.
+          # @!attribute [r] location
+          #   @return [::String]
+          #     Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation::LocationDetails::State]
+          #     Output only. The current state of the association in this location.
+          class LocationDetails
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The state of association.
+            module State
+              # Not set.
+              STATE_UNSPECIFIED = 0
+
+              # The association is ready and in sync with the linked endpoint group.
+              ACTIVE = 1
+
+              # The association is out of sync with the linked endpoint group.
+              # In most cases, this is a result of a transient issue within the system
+              # (e.g. an inaccessible location) and the system is expected to recover
+              # automatically.
+              OUT_OF_SYNC = 2
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The state of the association.
+          module State
+            # Not set.
+            STATE_UNSPECIFIED = 0
+
+            # The association is ready and in sync with the linked endpoint group.
+            ACTIVE = 1
+
+            # The association is being created.
+            CREATING = 3
+
+            # The association is being deleted.
+            DELETING = 4
+
+            # The association is disabled due to a breaking change in another resource.
+            CLOSED = 5
+
+            # The association is out of sync with the linked endpoint group.
+            # In most cases, this is a result of a transient issue within the system
+            # (e.g. an inaccessible location) and the system is expected to recover
+            # automatically. Check the `locations_details` field for more details.
+            OUT_OF_SYNC = 6
+
+            # An attempt to delete the association has failed. This is a terminal state
+            # and the association is not expected to be usable as some of its resources
+            # have been deleted.
+            # The only permitted operation is to retry deleting the association.
+            DELETE_FAILED = 7
+          end
+        end
+
+        # Request message for ListMirroringEndpointGroupAssociations.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of associations.
+        #     Example: `projects/123456789/locations/global`.
+        #     See https://google.aip.dev/132 for more details.
+        # @!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. See
+        #     https://google.aip.dev/158 for more details.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous
+        #     `ListMirroringEndpointGroups` call. Provide this to retrieve the subsequent
+        #     page. When paginating, all other parameters provided to
+        #     `ListMirroringEndpointGroups` must match the call that provided the page
+        #     token. See https://google.aip.dev/158 for more details.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression.
+        #     See https://google.aip.dev/160#filtering for more details.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Sort expression.
+        #     See https://google.aip.dev/132#ordering for more details.
+        class ListMirroringEndpointGroupAssociationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListMirroringEndpointGroupAssociations.
+        # @!attribute [rw] mirroring_endpoint_group_associations
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation>]
+        #     The associations from the specified parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        #     See https://google.aip.dev/158 for more details.
+        class ListMirroringEndpointGroupAssociationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetMirroringEndpointGroupAssociation.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the association to retrieve.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/mirroringEndpointGroupAssociations/\\{mirroring_endpoint_group_association}
+        class GetMirroringEndpointGroupAssociationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for CreateMirroringEndpointGroupAssociation.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this association will be created.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] mirroring_endpoint_group_association_id
+        #   @return [::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.
+        # @!attribute [rw] mirroring_endpoint_group_association
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation]
+        #     Required. The association to create.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class CreateMirroringEndpointGroupAssociationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateMirroringEndpointGroupAssociation.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        #     Fields are specified relative to the association
+        #     (e.g. `description`; *not*
+        #     `mirroring_endpoint_group_association.description`). See
+        #     https://google.aip.dev/161 for more details.
+        # @!attribute [rw] mirroring_endpoint_group_association
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringEndpointGroupAssociation]
+        #     Required. The association to update.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class UpdateMirroringEndpointGroupAssociationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for DeleteMirroringEndpointGroupAssociation.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The association to delete.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class DeleteMirroringEndpointGroupAssociationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A deployment group aggregates many zonal mirroring backends (deployments)
+        # into a single global mirroring service. Consumers can connect this service
+        # using an endpoint group.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Identifier. The resource name of this deployment group, for
+        #     example:
+        #     `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`.
+        #     See https://google.aip.dev/122 for more details.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was created.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was most recently updated.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels are key/value pairs that help to organize and filter
+        #     resources.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     Required. Immutable. The network that will be used for all child
+        #     deployments, for example: `projects/{project}/global/networks/{network}`.
+        #     See https://google.aip.dev/124.
+        # @!attribute [r] connected_endpoint_groups
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup::ConnectedEndpointGroup>]
+        #     Output only. The list of endpoint groups that are connected to this
+        #     resource.
+        # @!attribute [r] nested_deployments
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup::Deployment>]
+        #     Output only. The list of Mirroring Deployments that belong to this group.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup::State]
+        #     Output only. The current state of the deployment group.
+        #     See https://google.aip.dev/216.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     Output only. The current state of the resource does not match the user's
+        #     intended state, and the system is working to reconcile them. This is part
+        #     of the normal operation (e.g. adding a new deployment to the group) See
+        #     https://google.aip.dev/128.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description of the deployment group.
+        #     Used as additional context for the deployment group.
+        # @!attribute [r] locations
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringLocation>]
+        #     Output only. The list of locations where the deployment group is present.
+        class MirroringDeploymentGroup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # An endpoint group connected to this deployment group.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The connected endpoint group's resource name, for example:
+          #     `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`.
+          #     See https://google.aip.dev/124.
+          class ConnectedEndpointGroup
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A deployment belonging to this deployment group.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The name of the Mirroring Deployment, in the format:
+          #     `projects/{project}/locations/{location}/mirroringDeployments/{mirroring_deployment}`.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeployment::State]
+          #     Output only. Most recent known state of the deployment.
+          class Deployment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The current state of the deployment group.
+          module State
+            # State not set (this is not a valid state).
+            STATE_UNSPECIFIED = 0
+
+            # The deployment group is ready.
+            ACTIVE = 1
+
+            # The deployment group is being created.
+            CREATING = 2
+
+            # The deployment group is being deleted.
+            DELETING = 3
+
+            # The deployment group is being wiped out (project deleted).
+            CLOSED = 4
+          end
+        end
+
+        # Request message for ListMirroringDeploymentGroups.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!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. See
+        #     https://google.aip.dev/158 for more details.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous
+        #     `ListMirroringDeploymentGroups` call. Provide this to retrieve the
+        #     subsequent page. When paginating, all other parameters provided to
+        #     `ListMirroringDeploymentGroups` must match the call that provided the page
+        #     token. See https://google.aip.dev/158 for more details.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression.
+        #     See https://google.aip.dev/160#filtering for more details.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Sort expression.
+        #     See https://google.aip.dev/132#ordering for more details.
+        class ListMirroringDeploymentGroupsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListMirroringDeploymentGroups.
+        # @!attribute [rw] mirroring_deployment_groups
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup>]
+        #     The deployment groups from the specified parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        #     See https://google.aip.dev/158 for more details.
+        class ListMirroringDeploymentGroupsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetMirroringDeploymentGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the deployment group to retrieve.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/mirroringDeploymentGroups/\\{mirroring_deployment_group}
+        class GetMirroringDeploymentGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for CreateMirroringDeploymentGroup.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this deployment group will be created.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] mirroring_deployment_group_id
+        #   @return [::String]
+        #     Required. The ID to use for the new deployment group, which will become the
+        #     final component of the deployment group's resource name.
+        # @!attribute [rw] mirroring_deployment_group
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup]
+        #     Required. The deployment group to create.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class CreateMirroringDeploymentGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateMirroringDeploymentGroup.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        #     Fields are specified relative to the deployment group
+        #     (e.g. `description`; *not*
+        #     `mirroring_deployment_group.description`). See
+        #     https://google.aip.dev/161 for more details.
+        # @!attribute [rw] mirroring_deployment_group
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeploymentGroup]
+        #     Required. The deployment group to update.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class UpdateMirroringDeploymentGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for DeleteMirroringDeploymentGroup.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The deployment group to delete.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class DeleteMirroringDeploymentGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A deployment represents a zonal mirroring backend ready to accept
+        # GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by
+        # an internal passthrough load balancer. Deployments are always part of a
+        # global deployment group which represents a global mirroring service.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Identifier. The resource name of this deployment, for example:
+        #     `projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep`.
+        #     See https://google.aip.dev/122 for more details.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was created.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the resource was most recently updated.
+        #     See https://google.aip.dev/148#timestamps.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels are key/value pairs that help to organize and filter
+        #     resources.
+        # @!attribute [rw] forwarding_rule
+        #   @return [::String]
+        #     Required. Immutable. The regional forwarding rule that fronts the mirroring
+        #     collectors, for example:
+        #     `projects/123456789/regions/us-central1/forwardingRules/my-rule`. See
+        #     https://google.aip.dev/124.
+        # @!attribute [rw] mirroring_deployment_group
+        #   @return [::String]
+        #     Required. Immutable. The deployment group that this deployment is a part
+        #     of, for example:
+        #     `projects/123456789/locations/global/mirroringDeploymentGroups/my-dg`.
+        #     See https://google.aip.dev/124.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeployment::State]
+        #     Output only. The current state of the deployment.
+        #     See https://google.aip.dev/216.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     Output only. The current state of the resource does not match the user's
+        #     intended state, and the system is working to reconcile them. This part of
+        #     the normal operation (e.g. linking a new association to the parent group).
+        #     See https://google.aip.dev/128.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description of the deployment.
+        #     Used as additional context for the deployment.
+        class MirroringDeployment
+          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
+
+          # The current state of the deployment.
+          module State
+            # State not set (this is not a valid state).
+            STATE_UNSPECIFIED = 0
+
+            # The deployment is ready and in sync with the parent group.
+            ACTIVE = 1
+
+            # The deployment is being created.
+            CREATING = 2
+
+            # The deployment is being deleted.
+            DELETING = 3
+
+            # The deployment is out of sync with the parent group.
+            # In most cases, this is a result of a transient issue within the system
+            # (e.g. a delayed data-path config) and the system is expected to recover
+            # automatically. See the parent deployment group's state for more details.
+            OUT_OF_SYNC = 4
+
+            # An attempt to delete the deployment has failed. This is a terminal state
+            # and the deployment is not expected to recover. The only permitted
+            # operation is to retry deleting the deployment.
+            DELETE_FAILED = 5
+          end
+        end
+
+        # Request message for ListMirroringDeployments.
+        # @!attribute [rw] parent
+        #   @return [::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.
+        # @!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. See
+        #     https://google.aip.dev/158 for more details.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListMirroringDeployments`
+        #     call. Provide this to retrieve the subsequent page. When paginating, all
+        #     other parameters provided to `ListMirroringDeployments` must match the call
+        #     that provided the page token. See https://google.aip.dev/158 for more
+        #     details.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter expression.
+        #     See https://google.aip.dev/160#filtering for more details.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Sort expression.
+        #     See https://google.aip.dev/132#ordering for more details.
+        class ListMirroringDeploymentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ListMirroringDeployments.
+        # @!attribute [rw] mirroring_deployments
+        #   @return [::Array<::Google::Cloud::NetworkSecurity::V1::MirroringDeployment>]
+        #     The deployments from the specified parent.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as `page_token` to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        #     See https://google.aip.dev/158 for more details.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListMirroringDeploymentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for GetMirroringDeployment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the deployment to retrieve.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/mirroringDeployments/\\{mirroring_deployment}
+        class GetMirroringDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for CreateMirroringDeployment.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this deployment will be created.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] mirroring_deployment_id
+        #   @return [::String]
+        #     Required. The ID to use for the new deployment, which will become the final
+        #     component of the deployment's resource name.
+        # @!attribute [rw] mirroring_deployment
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeployment]
+        #     Required. The deployment to create.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class CreateMirroringDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for UpdateMirroringDeployment.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        #     Fields are specified relative to the deployment
+        #     (e.g. `description`; *not* `mirroring_deployment.description`).
+        #     See https://google.aip.dev/161 for more details.
+        # @!attribute [rw] mirroring_deployment
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringDeployment]
+        #     Required. The deployment to update.
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class UpdateMirroringDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for DeleteMirroringDeployment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        # @!attribute [rw] request_id
+        #   @return [::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.
+        class DeleteMirroringDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Details about mirroring in a specific cloud location.
+        # @!attribute [r] location
+        #   @return [::String]
+        #     Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::NetworkSecurity::V1::MirroringLocation::State]
+        #     Output only. The current state of the association in this location.
+        class MirroringLocation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The current state of a resource in the location.
+          module State
+            # State not set (this is not a valid state).
+            STATE_UNSPECIFIED = 0
+
+            # The resource is ready and in sync in the location.
+            ACTIVE = 1
+
+            # The resource is out of sync in the location.
+            # In most cases, this is a result of a transient issue within the system
+            # (e.g. an inaccessible location) and the system is expected to recover
+            # automatically.
+            OUT_OF_SYNC = 2
+          end
+        end
+      end
+    end
+  end
+end