Source code for braket.task_result.quera_metadata_v1

# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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 pydantic.v1 import Field, conint

from braket.schema_common import BraketSchemaBase, BraketSchemaHeader



[docs]
class QueraMetadata(BraketSchemaBase):
    """
    The Querametadata result schema.

    Attributes:
        braketSchemaHeader (BraketSchemaHeader): Schema header.
            Users do not need to set this value. Only default is allowed.
        numSuccessfulShots (int): Number of successful shots in result.

    Examples:
        >>> QueraMetadata(numSuccessfulShots=100)
    """

    _QUERA_METADATA_HEADER = BraketSchemaHeader(
        name="braket.task_result.quera_metadata", version="1"
    )
    braketSchemaHeader: BraketSchemaHeader = Field(
        default=_QUERA_METADATA_HEADER, const=_QUERA_METADATA_HEADER
    )

    numSuccessfulShots: conint(ge=0, le=1000)