# -*- coding: utf-8 -*-
# Copyright 2025 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
#
#     http://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.
#
from __future__ import annotations

from typing import MutableMapping, MutableSequence

from google.protobuf import field_mask_pb2  # type: ignore
import proto  # type: ignore

from google.ads.admanager_v1.types import entity_signals_mapping_messages

__protobuf__ = proto.module(
    package="google.ads.admanager.v1",
    manifest={
        "GetEntitySignalsMappingRequest",
        "ListEntitySignalsMappingsRequest",
        "CreateEntitySignalsMappingRequest",
        "UpdateEntitySignalsMappingRequest",
        "ListEntitySignalsMappingsResponse",
        "BatchCreateEntitySignalsMappingsRequest",
        "BatchCreateEntitySignalsMappingsResponse",
        "BatchUpdateEntitySignalsMappingsRequest",
        "BatchUpdateEntitySignalsMappingsResponse",
    },
)


class GetEntitySignalsMappingRequest(proto.Message):
    r"""Request object for ``GetEntitySignalsMapping`` method.

    Attributes:
        name (str):
            Required. The resource name of the EntitySignalsMapping.
            Format:
            ``networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}``
    """

    name: str = proto.Field(
        proto.STRING,
        number=1,
    )


class ListEntitySignalsMappingsRequest(proto.Message):
    r"""Request object for ``ListEntitySignalsMappings`` method.

    Attributes:
        parent (str):
            Required. The parent, which owns this collection of
            EntitySignalsMappings. Format: ``networks/{network_code}``
        page_size (int):
            Optional. The maximum number of ``EntitySignalsMappings`` to
            return. The service may return fewer than this value. If
            unspecified, at most 50 ``EntitySignalsMappings`` will be
            returned. The maximum value is 1000; values above 1000 will
            be coerced to 1000.
        page_token (str):
            Optional. A page token, received from a previous
            ``ListEntitySignalsMappings`` call. Provide this to retrieve
            the subsequent page.

            When paginating, all other parameters provided to
            ``ListEntitySignalsMappings`` must match the call that
            provided the page token.
        filter (str):
            Optional. Expression to filter the response.
            See syntax details at
            https://developers.google.com/ad-manager/api/beta/filters
        order_by (str):
            Optional. Expression to specify sorting
            order. See syntax details at
            https://developers.google.com/ad-manager/api/beta/filters#order
        skip (int):
            Optional. Number of individual resources to
            skip while paginating.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    page_size: int = proto.Field(
        proto.INT32,
        number=2,
    )
    page_token: str = proto.Field(
        proto.STRING,
        number=3,
    )
    filter: str = proto.Field(
        proto.STRING,
        number=4,
    )
    order_by: str = proto.Field(
        proto.STRING,
        number=5,
    )
    skip: int = proto.Field(
        proto.INT32,
        number=6,
    )


class CreateEntitySignalsMappingRequest(proto.Message):
    r"""Request object for 'CreateEntitySignalsMapping' method.

    Attributes:
        parent (str):
            Required. The parent resource where this
            EntitySignalsMapping will be created. Format:
            ``networks/{network_code}``
        entity_signals_mapping (google.ads.admanager_v1.types.EntitySignalsMapping):
            Required. The EntitySignalsMapping object to
            create.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    entity_signals_mapping: entity_signals_mapping_messages.EntitySignalsMapping = (
        proto.Field(
            proto.MESSAGE,
            number=2,
            message=entity_signals_mapping_messages.EntitySignalsMapping,
        )
    )


class UpdateEntitySignalsMappingRequest(proto.Message):
    r"""Request object for 'UpdateEntitySignalsMapping' method.

    Attributes:
        entity_signals_mapping (google.ads.admanager_v1.types.EntitySignalsMapping):
            Required. The ``EntitySignalsMapping`` to update.

            The EntitySignalsMapping's name is used to identify the
            EntitySignalsMapping to update. Format:
            ``networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}``
        update_mask (google.protobuf.field_mask_pb2.FieldMask):
            Required. The list of fields to update.
    """

    entity_signals_mapping: entity_signals_mapping_messages.EntitySignalsMapping = (
        proto.Field(
            proto.MESSAGE,
            number=1,
            message=entity_signals_mapping_messages.EntitySignalsMapping,
        )
    )
    update_mask: field_mask_pb2.FieldMask = proto.Field(
        proto.MESSAGE,
        number=2,
        message=field_mask_pb2.FieldMask,
    )


class ListEntitySignalsMappingsResponse(proto.Message):
    r"""Response object for ``ListEntitySignalsMappingsRequest`` containing
    matching ``EntitySignalsMapping`` resources.

    Attributes:
        entity_signals_mappings (MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]):
            The ``EntitySignalsMapping`` from the specified network.
        next_page_token (str):
            A token, which can be sent as ``page_token`` to retrieve the
            next page. If this field is omitted, there are no subsequent
            pages.
        total_size (int):
            Total number of ``EntitySignalsMappings``. If a filter was
            included in the request, this reflects the total number
            after the filtering is applied.

            ``total_size`` won't be calculated in the response unless it
            has been included in a response field mask. The response
            field mask can be provided to the method by using the URL
            parameter ``$fields`` or ``fields``, or by using the
            HTTP/gRPC header ``X-Goog-FieldMask``.

            For more information, see
            https://developers.google.com/ad-manager/api/beta/field-masks
    """

    @property
    def raw_page(self):
        return self

    entity_signals_mappings: MutableSequence[
        entity_signals_mapping_messages.EntitySignalsMapping
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=entity_signals_mapping_messages.EntitySignalsMapping,
    )
    next_page_token: str = proto.Field(
        proto.STRING,
        number=2,
    )
    total_size: int = proto.Field(
        proto.INT32,
        number=3,
    )


class BatchCreateEntitySignalsMappingsRequest(proto.Message):
    r"""Request object for ``BatchCreateEntitySignalsMappings`` method.

    Attributes:
        parent (str):
            Required. The parent resource where
            ``EntitySignalsMappings`` will be created. Format:
            ``networks/{network_code}`` The parent field in the
            CreateEntitySignalsMappingRequest must match this field.
        requests (MutableSequence[google.ads.admanager_v1.types.CreateEntitySignalsMappingRequest]):
            Required. The ``EntitySignalsMapping`` objects to create. A
            maximum of 100 objects can be created in a batch.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    requests: MutableSequence[
        "CreateEntitySignalsMappingRequest"
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=2,
        message="CreateEntitySignalsMappingRequest",
    )


class BatchCreateEntitySignalsMappingsResponse(proto.Message):
    r"""Response object for ``BatchCreateEntitySignalsMappings`` method.

    Attributes:
        entity_signals_mappings (MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]):
            The ``EntitySignalsMapping`` objects created.
    """

    entity_signals_mappings: MutableSequence[
        entity_signals_mapping_messages.EntitySignalsMapping
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=entity_signals_mapping_messages.EntitySignalsMapping,
    )


class BatchUpdateEntitySignalsMappingsRequest(proto.Message):
    r"""Request object for ``BatchUpdateEntitySignalsMappings`` method.

    Attributes:
        parent (str):
            Required. The parent resource where
            ``EntitySignalsMappings`` will be updated. Format:
            ``networks/{network_code}`` The parent field in the
            UpdateEntitySignalsMappingRequest must match this field.
        requests (MutableSequence[google.ads.admanager_v1.types.UpdateEntitySignalsMappingRequest]):
            Required. The ``EntitySignalsMapping`` objects to update. A
            maximum of 100 objects can be updated in a batch.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    requests: MutableSequence[
        "UpdateEntitySignalsMappingRequest"
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=2,
        message="UpdateEntitySignalsMappingRequest",
    )


class BatchUpdateEntitySignalsMappingsResponse(proto.Message):
    r"""Response object for ``BatchUpdateEntitySignalsMappings`` method.

    Attributes:
        entity_signals_mappings (MutableSequence[google.ads.admanager_v1.types.EntitySignalsMapping]):
            The ``EntitySignalsMapping`` objects updated.
    """

    entity_signals_mappings: MutableSequence[
        entity_signals_mapping_messages.EntitySignalsMapping
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=entity_signals_mapping_messages.EntitySignalsMapping,
    )


__all__ = tuple(sorted(__protobuf__.manifest))
