Skip to content

export_schema

export_schema(
    registry_name: __string,
    schema_name: __string,
    *,
    config_overrides: Optional[schemasClientConfig] = None,
    schema_version: Optional[__string] = None,
    type: Optional[__string] = None,
) -> ExportSchemaResponse

export_schema

Parameters:

  • registry_name (__string) –

    The name of the registry.

  • schema_name (__string) –

    The name of the schema.

  • schema_version (Optional[__string], default: None ) –

    Specifying this limits the results to only this schema version.

Raises:

Source code in docs_src/capo_schemas/_services/schemas.py
def export_schema(
    self,
    registry_name: "capo_schemas.types.__string.__string",
    schema_name: "capo_schemas.types.__string.__string",
    *,
    config_overrides: Optional[schemasClientConfig] = None,
    schema_version: Optional["capo_schemas.types.__string.__string"] = None,
    type: Optional["capo_schemas.types.__string.__string"] = None,
) -> "capo_schemas.types.export_schema_response.ExportSchemaResponse":
    """export_schema

    Args:
        registry_name: <p>The name of the registry.</p>
        schema_name: <p>The name of the schema.</p>
        schema_version: <p>Specifying this limits the results to only this schema version.</p>

    Raises:
        capo_schemas.errors.bad_request_exception.BadRequestException
        capo_schemas.errors.forbidden_exception.ForbiddenException
        capo_schemas.errors.internal_server_error_exception.InternalServerErrorException
        capo_schemas.errors.not_found_exception.NotFoundException
        capo_schemas.errors.service_unavailable_exception.ServiceUnavailableException
        capo_schemas.errors.too_many_requests_exception.TooManyRequestsException
        capo_schemas.errors.unauthorized_exception.UnauthorizedException
        capo_schemas.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_schemas.types.export_schema_request.ExportSchemaRequest]",
    ) -> OperationResponse[
        "capo_schemas.types.export_schema_response.ExportSchemaResponse"
    ]:
        import capo_schemas._operations.schemas.export_schema

        output, http_response = (
            capo_schemas._operations.schemas.export_schema.export_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExportSchema")
    )
    input_: capo_schemas.types.export_schema_request.ExportSchemaRequest = {
        "registry_name": registry_name,
        "schema_name": schema_name,
    }
    if schema_version is not None:
        input_["schema_version"] = schema_version
    if type is not None:
        input_["type"] = type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output