openapi: 3.2.0
info:
  description: 'Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.

    '
  title: Golden Gate API
  version: '20200407'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/574c6d02b34ad396affeace9aa7c25dae19c5135914533ef68ff90be16d46776.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the GoldenGate API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/574c6d02b34ad396affeace9aa7c25dae19c5135914533ef68ff90be16d46776.yaml
    what: the harvested document for GoldenGate API
servers:
- url: http://127.0.0.1/20200407
- url: https://127.0.0.1/20200407
tags:
- name: goldenGate
paths:
  /aiModels:
    get:
      description: 'Returns the list of AI models for the specified provider. If the

        provider requires additional context to resolve its supported models,

        that context must be supplied in the request.

        '
      operationId: ListAiModels
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AiProviderTypeQueryParam'
      - $ref: '#/components/parameters/AiModelRegionQueryParam'
      - $ref: '#/components/parameters/AiModelTenancyIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'AI models were retrieved successfully.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiModelCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists AI models for the specified provider.
      tags:
      - goldenGate
  /aiProviders:
    get:
      description: 'Returns the list of AI providers along with their supported models.

        '
      operationId: ListAiProviders
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'AI providers were retrieved successfully.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiProviderCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists supported AI providers and their models.
      tags:
      - goldenGate
  /connectionAssignments:
    get:
      description: Lists the Connection Assignments in the compartment.
      operationId: ListConnectionAssignments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentIdQueryParam'
      - $ref: '#/components/parameters/ConnectionIdQueryParam'
      - $ref: '#/components/parameters/ConnectionTypeQueryParam'
      - $ref: '#/components/parameters/ConnectionTypeNotEqualToQueryParam'
      - $ref: '#/components/parameters/AliasNameQueryParam'
      - $ref: '#/components/parameters/ConnectionAssignmentLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Connection Assignment collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAssignmentCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the Connections Assignments in the compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/ConnectionAssignment'
    post:
      description: Creates a new Connection Assignment.
      operationId: CreateConnectionAssignment
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        201:
          description: 'The Connection Assignment was created successfully.

            Note: Fully creating a Connection Assignment is an asynchronous process. To determine the

            state of the Connection Assignment, check the Connection Assignment''s lifecycleState

            and/or the work request associated with the ocp-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAssignment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Connection Assignment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/ConnectionAssignment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionAssignmentDetails'
        description: Specification of the connection assignment to create.
        required: true
  /connectionAssignments/{connectionAssignmentId}:
    delete:
      description: Deletes a Connection Assignment.
      operationId: DeleteConnectionAssignment
      parameters:
      - $ref: '#/components/parameters/ConnectionAssignmentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the state of the delete operation,

            check the work request identified by the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Connection Assignment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/ConnectionAssignment'
    get:
      description: 'Retrieves a Connection Assignment.

        '
      operationId: GetConnectionAssignment
      parameters:
      - $ref: '#/components/parameters/ConnectionAssignmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Connection Assignment was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAssignment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Connection Assignment.
      tags:
      - goldenGate
  /connectionAssignments/{connectionAssignmentId}/actions/test:
    post:
      description: 'Tests the connectivity between given GoldenGate deployment and one of the associated database / service.

        When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: TestConnectionAssignment
      parameters:
      - $ref: '#/components/parameters/ConnectionAssignmentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'Action performed.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionAssignmentResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Tests DB/service connectivity from a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/ConnectionAssignment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestConnectionAssignmentDetails'
        description: 'A placeholder for any additional metadata to describe the requested tests of the assigned connection.

          '
        required: true
  /connections:
    get:
      description: 'Lists the Connections in the compartment.

        '
      operationId: ListConnections
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/TechnologyTypeQueryParam'
      - $ref: '#/components/parameters/ConnectionTypeQueryParam'
      - $ref: '#/components/parameters/ConnectionTypeNotEqualToQueryParam'
      - $ref: '#/components/parameters/AssignedDeploymentIdQueryParam'
      - $ref: '#/components/parameters/AssignableDeploymentIdQueryParam'
      - $ref: '#/components/parameters/AssignableDeploymentTypeQueryParam'
      - $ref: '#/components/parameters/ConnectionLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Connections collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the Connections in the compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
    post:
      description: 'Creates a new Connection.

        '
      operationId: CreateConnection
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'The Connection was created successfully.

            Note: Fully creating a Connection is an asynchronous process. To determine the

            state of the Connection, check the Connection''s lifecycleState

            and/or the work request associated with the ocp-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Connection.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionDetails'
        description: 'Specification of the Connection to create.

          '
        required: true
  /connections/{connectionId}:
    delete:
      description: 'Deletes a Connection.

        '
      operationId: DeleteConnection
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the state of the delete operation,

            check the Connection''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Connection.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
    get:
      description: 'Retrieves a Connection.

        '
      operationId: GetConnection
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ConnectionDetailsViewParam'
      responses:
        200:
          description: 'The Connection was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Connection.
      tags:
      - goldenGate
    put:
      description: 'Updates the Connection.

        '
      operationId: UpdateConnection
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Update request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Connection''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the Connection identified by the id.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionDetails'
        description: 'The new Connection specifications to apply.

          '
        required: true
  /connections/{connectionId}/actions/addLock:
    post:
      description: Adds a lock to a Connection resource.
      operationId: AddConnectionLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned Connection resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Adds a lock to a Connection resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
  /connections/{connectionId}/actions/changeCompartment:
    post:
      description: 'Moves the Connection into a different compartment within the same tenancy. When

        provided, If-Match is checked against ETag values of the resource.  For information about

        moving resources between compartments, see [Moving Resources Between

        Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeConnectionCompartment
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Move request accepted.


            Note: This is an asynchronous operation. To determine the state of the move operation,

            check the Connection''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the Connection to a different compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeConnectionCompartmentDetails'
        description: 'Properties to change the compartment of a Connection.

          '
        required: true
  /connections/{connectionId}/actions/changeSubscription:
    post:
      description: 'Associate a GoldanGate connection with a different subscription.

        '
      operationId: ChangeConnectionSubscription
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OptionalRequestId'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request was successfully received and the update subscription action is being performed.
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Associate a GoldenGate connection with a different subscription.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeConnectionSubscriptionDetails'
        description: 'Associate a GoldenGate connection with a different subscription.

          '
        required: true
  /connections/{connectionId}/actions/migrate:
    post:
      description: 'Migrate Connection attributes.

        '
      operationId: MigrateConnection
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Migrate Connection attributes request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Connection''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Migrate Connection attributes.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MigrateConnectionDetails'
        description: 'Details of the migrated Connection.

          '
        required: true
  /connections/{connectionId}/actions/refresh:
    post:
      description: 'Refresh the external Connection attributes.

        '
      operationId: RefreshConnection
      parameters:
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Refresh Connection external attributes request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Connection''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Refresh external Connection attributes.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshConnectionDetails'
        description: 'Details of refresh external Connection attributes.

          '
        required: true
  /connections/{connectionId}/actions/removeLock:
    post:
      description: Removes a lock from a Connection resource.
      operationId: RemoveConnectionLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/ConnectionIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned Connection resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Removes a lock to a Connection resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Connection'
  /databaseRegistrations:
    get:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Lists the DatabaseRegistrations in the compartment.

        '
      operationId: ListDatabaseRegistrations
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The DatabaseRegistrations collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistrationCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the DatabaseRegistrations in the compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DatabaseRegistration'
    post:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Creates a new DatabaseRegistration.

        '
      operationId: CreateDatabaseRegistration
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'The DatabaseRegistration was created successfully.


            Note: Fully creating a DatabaseRegistration is an asynchronous process. To determine the

            state of the DatabaseRegistration, check the DatabaseRegistration''s lifecycleState

            and/or the work request associated with the ocp-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistration'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new DatabaseRegistration.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DatabaseRegistration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatabaseRegistrationDetails'
        description: 'Specification of the DatabaseRegistration to create.

          '
        required: true
  /databaseRegistrations/{databaseRegistrationId}:
    delete:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Deletes a DatabaseRegistration.

        '
      operationId: DeleteDatabaseRegistration
      parameters:
      - $ref: '#/components/parameters/DatabaseRegistrationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the state of the delete operation,

            check the DatabaseRegistration''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a DatabaseRegistration.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DatabaseRegistration'
    get:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Retrieves a DatabaseRegistration.

        '
      operationId: GetDatabaseRegistration
      parameters:
      - $ref: '#/components/parameters/DatabaseRegistrationIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The DatabaseRegistration was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseRegistration'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a DatabaseRegistration.
      tags:
      - goldenGate
    put:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Updates the DatabaseRegistration.

        '
      operationId: UpdateDatabaseRegistration
      parameters:
      - $ref: '#/components/parameters/DatabaseRegistrationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Update request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the DatabaseRegistration''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the DatabaseRegistration identified by the id.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DatabaseRegistration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseRegistrationDetails'
        description: 'The new DatabaseRegistration specifications to apply.

          '
        required: true
  /databaseRegistrations/{databaseRegistrationId}/actions/changeCompartment:
    post:
      deprecated: true
      description: 'Note: Deprecated. Use the /connections API instead.

        Moves the DatabaseRegistration into a different compartment within the same tenancy. When

        provided, If-Match is checked against ETag values of the resource.  For information about

        moving resources between compartments, see [Moving Resources Between

        Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeDatabaseRegistrationCompartment
      parameters:
      - $ref: '#/components/parameters/DatabaseRegistrationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Move request accepted.


            Note: This is an asynchronous operation. To determine the state of the move operation,

            check the DatabaseRegistration''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
            sunset:
              description: 'Deprecation date of this API version.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the DatabaseRegistration to a different compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DatabaseRegistration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDatabaseRegistrationCompartmentDetails'
        description: 'Properties to change the compartment of a DatabaseRegistration.

          '
        required: true
  /deploymentBackups:
    get:
      description: 'Lists the Backups in a compartment.

        '
      operationId: ListDeploymentBackups
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentBackupLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Successfully retrieved a collection of Backups.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackupCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the DeploymentBackups in a compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
    post:
      description: Creates a new DeploymentBackup.
      operationId: CreateDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'Successfully created a DeploymentBackup. Note: fully creating a DeploymentBackup is an asynchronous process,

            check the lifecycleState of the DeploymentBackup and/or the work request associated with the ocp-work-request-id

            returned in the header to determine the state of the DeploymentBackup.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new DeploymentBackup
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentBackupDetails'
        description: Specification of the DeploymentBackup to create.
        required: true
  /deploymentBackups/{deploymentBackupId}:
    delete:
      description: 'Deletes a DeploymentBackup.

        '
      operationId: DeleteDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the state of the delete operation,

            check the Deployment Backups''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a DeploymentBackup.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
    get:
      description: 'Retrieves a DeploymentBackup.

        '
      operationId: GetDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'DeploymentBackup was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a DeploymentBackup
      tags:
      - goldenGate
    put:
      description: 'Modifies a Deployment Backup.

        '
      operationId: UpdateDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        200:
          description: 'The DeploymentBackup was successfully updated.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies a Deployment Backup
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentBackupDetails'
        description: 'The information to be updated.

          '
        required: true
  /deploymentBackups/{deploymentBackupId}/actions/addLock:
    post:
      description: Adds a lock to a DeploymentBackup resource.
      operationId: AddDeploymentBackupLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned DeploymentBackup resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Adds a lock to a DeploymentBackup resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
  /deploymentBackups/{deploymentBackupId}/actions/cancel:
    post:
      description: Cancels a Deployment Backup creation process.
      operationId: CancelDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The Cancel Deployment Backup request was accepted.


            Note: This is an asynchronous operation. To determine the DeploymentBackup''s state, check the

            DeploymentBackup''s lifecycleState or work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancels deployment backup creation process
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelDeploymentBackupDetails'
        description: 'A placeholder for any additional metadata to describe the deployment backup cancel.

          '
        required: true
  /deploymentBackups/{deploymentBackupId}/actions/changeCompartment:
    post:
      description: 'Moves a DeploymentBackup into a different compartment within the same tenancy.  When provided,

        If-Match is checked against ETag values of the resource.  For information about moving

        resources between compartments, see [Moving Resources Between

        Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeDeploymentBackupCompartment
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        204:
          description: 'The DeploymentBackup was successfully moved.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the DeploymentBackup into a different compartment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDeploymentBackupCompartmentDetails'
        description: 'Properties to change the compartment of a DeploymentBackup.

          '
        required: true
  /deploymentBackups/{deploymentBackupId}/actions/copyToBucket:
    post:
      description: Creates a copy of a Deployment Backup.
      operationId: CopyDeploymentBackup
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'The Copy Deployment Backup request was accepted.


            Note: This is an asynchronous operation. To determine the DeploymentBackup''s state, check the

            DeploymentBackup''s lifecycleState or work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a copy of a Deployment Backup.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyDeploymentBackupDetails'
        description: 'A placeholder for any additional metadata to describe the copy of a Deployment Backup.

          '
        required: true
  /deploymentBackups/{deploymentBackupId}/actions/removeLock:
    post:
      description: Removes a lock from a DeploymentBackup resource.
      operationId: RemoveDeploymentBackupLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned DeploymentBackup resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Removes a lock to a DeploymentBackup resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
  /deploymentBackups/{deploymentBackupId}/actions/restore:
    post:
      description: Restores a Deployment from a Deployment Backup created from the same Deployment.
      operationId: RestoreDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The Restore Deployment request was accepted.


            Note: This is an asynchronous operation. To determine the Deployment''s state, check the

            Deployment''s lifecycleState or work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Restores a deployment from the Object Store
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreDeploymentDetails'
        description: 'A placeholder for any additional metadata to describe the deployment restore.

          '
        required: true
  /deploymentEnvironments:
    get:
      description: 'Returns an array of DeploymentEnvironmentDescriptor

        '
      operationId: ListDeploymentEnvironments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'DeploymentEnvironmentDescriptorList retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentEnvironmentCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get available deployment environment specific meta-data.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentEnvironmentCollection'
  /deploymentTypes:
    get:
      description: 'Returns an array of DeploymentTypeDescriptor

        '
      operationId: ListDeploymentTypes
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentTypeQueryParam'
      - $ref: '#/components/parameters/OggVersionQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'DeploymentTypeDescriptorList retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentTypeCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get available deployment type specific meta-data.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentTypeCollection'
  /deploymentUpgrades:
    get:
      description: 'Lists the Deployment Upgrades in a compartment.

        '
      operationId: ListDeploymentUpgrades
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentUpgradeLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The DeploymentUpgrades collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentUpgradeCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the Deployment Upgrades in a compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentUpgrade'
  /deploymentUpgrades/{deploymentUpgradeId}:
    get:
      description: 'Retrieves a deployment upgrade.

        '
      operationId: GetDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Deployment Upgrade was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentUpgrade'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a deployment upgrade.
      tags:
      - goldenGate
  /deploymentUpgrades/{deploymentUpgradeId}/actions/cancel:
    post:
      description: 'Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: CancelDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'The DeploymentUpgrade was successfully cancelled.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentUpgrade'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancels a DeploymentUpgrade.
      tags:
      - goldenGate
      x-example: "Example: Cancels an automatically scheduled upgrade. \nPOST /20200407/deploymentUpgrades/ocid1.ggsdeploymentupgrade.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a/actions/cancel\nHost: goldengate.us-phoenix-1.oci.oraclecloud.com\n{\n  \"type\": \"DEFAULT\"\n}\n"
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelDeploymentUpgradeDetails'
        description: 'A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.

          '
        required: true
  /deploymentUpgrades/{deploymentUpgradeId}/actions/cancelSnooze:
    post:
      description: 'Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: CancelSnoozeDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'The DeploymentUpgrade snooze was successfully canceled.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel snooze of a DeploymentUpgrade.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSnoozeDeploymentUpgradeDetails'
        description: 'A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.

          '
        required: true
  /deploymentUpgrades/{deploymentUpgradeId}/actions/reschedule:
    post:
      description: 'Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: RescheduleDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'The DeploymentUpgrade was successfully rescheduled.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentUpgrade'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Reschedules a DeploymentUpgrade.
      tags:
      - goldenGate
      x-example: "Example: Reschedules an automatically scheduled upgrade. \nPOST /20200407/deploymentUpgrades/ocid1.ggsdeploymentupgrade.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a/actions/reschedule\nHost: goldengate.us-phoenix-1.oci.oraclecloud.com\n{\n  \"type\": \"RESCHEDULE_TO_DATE\",\n  \"timeSchedule\": \"2024-01-01T12:00:00.000Z\"\n}\n"
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RescheduleDeploymentUpgradeDetails'
        description: 'Properties to reschedule DeploymentUpgrade.

          '
        required: true
  /deploymentUpgrades/{deploymentUpgradeId}/actions/rollback:
    post:
      description: 'Rollback a deployment to it''s previous version. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: RollbackDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Request to rollback DeploymentUpgrade accepted.


            Note: This is an asynchronous operation. To determine the deployment''s state, check the

            deployment''s lifecycleState or the work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Rollback a DeploymentUpgrade.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RollbackDeploymentUpgradeDetails'
        description: 'A placeholder for any additional metadata to describe the deployment rollback.

          '
        required: true
  /deploymentUpgrades/{deploymentUpgradeId}/actions/snooze:
    post:
      description: 'Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: SnoozeDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'The DeploymentUpgrade was successfully snoozed.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Snooze a DeploymentUpgrade.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnoozeDeploymentUpgradeDetails'
        description: 'A placeholder for any additional metadata to describe the snooze of deployment upgrade.

          '
        required: true
  /deploymentUpgrades/{deploymentUpgradeId}/actions/upgrade:
    post:
      description: 'Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: UpgradeDeploymentUpgrade
      parameters:
      - $ref: '#/components/parameters/DeploymentUpgradeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Request to upgrade deployment accepted.


            Note: This is an asynchronous operation. To determine the deployment''s state, check the

            deployment''s lifecycleState or the work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Upgrade a deployment to specific version.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentUpgrade'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeDeploymentUpgradeDetails'
        description: 'A placeholder for any additional metadata to describe the deployment upgrade.

          '
        required: true
  /deploymentVersions:
    get:
      description: 'Returns the list of available deployment versions.

        '
      operationId: ListDeploymentVersions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentIdQueryParam'
      - $ref: '#/components/parameters/DeploymentTypeQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'DeploymentVersionCollection retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentVersionCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get available deployment versions.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentVersionCollection'
  /deployments:
    get:
      description: 'Lists the Deployments in a compartment.

        '
      operationId: ListDeployments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SupportedConnectionTypeQueryParam'
      - $ref: '#/components/parameters/AssignedConnectionIdQueryParam'
      - $ref: '#/components/parameters/AssignableConnectionIdQueryParam'
      - $ref: '#/components/parameters/DeploymentLifecycleStateQueryParam'
      - $ref: '#/components/parameters/LifecycleSubStateQueryParam'
      - $ref: '#/components/parameters/DeploymentTypeSelectorQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/FqdnQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Deployments collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the Deployments in a compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
    post:
      description: 'Creates a new Deployment.

        '
      operationId: CreateDeployment
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'Deployment created successfully.


            Note: Fully creating a Deployment is an asynchronous process. To determine the state of

            the Deployment, check the Deployment''s lifecycleState and/or the work request associated

            with the ocp-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentDetails'
        description: 'Specifications to create the Deployment.

          '
        required: true
  /deployments/{deploymentId}:
    delete:
      description: 'Deletes the Deployment.

        '
      operationId: DeleteDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the Deployment''s state, check the

            Deployment''s lifecycleState and/or the work request identified by the

            opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the Deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
    get:
      description: 'Retrieves a deployment.

        '
      operationId: GetDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Deployment was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a deployment.
      tags:
      - goldenGate
    put:
      description: 'Modifies a Deployment.

        '
      operationId: UpdateDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Update request accepted.


            Note: This is an asynchronous operation. To determine the state of the Deployment, check

            the Deployment''s lifecycleState and/or the work request identified by the

            opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies a Deployment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentDetails'
        description: 'The information to be updated.

          '
        required: true
  /deployments/{deploymentId}/actions/addLocalPeer:
    post:
      description: 'Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: AddDeploymentLocalPeer
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The add deployment peer request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Add a new deployment local peer
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDeploymentLocalPeerDetails'
        description: 'Metadata to add a local deployment

          '
        required: true
  /deployments/{deploymentId}/actions/addLock:
    post:
      description: Adds a lock to a Deployment resource.
      operationId: AddDeploymentLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned Deployment resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Adds a lock to a Deployment resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
  /deployments/{deploymentId}/actions/changeCompartment:
    post:
      description: 'Moves the Deployment into a different compartment within the same tenancy.  When provided,

        If-Match is checked against ETag values of the resource.  For information about moving

        resources between compartments, see [Moving Resources Between

        Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeDeploymentCompartment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Move request accepted.


            Note: This is an asynchronous operation. To determine the state of the move operation,

            check the Deployment''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the Deployment into a different compartment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDeploymentCompartmentDetails'
        description: 'Properties to change the compartment of a Deployment.

          '
        required: true
  /deployments/{deploymentId}/actions/changeSubscription:
    post:
      description: 'Associate a GoldanGate deployment with a different subscription.

        '
      operationId: ChangeDeploymentSubscription
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OptionalRequestId'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request was successfully received and the update subscription action is being performed.
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Associate a GoldenGate deployment with a different subscription.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDeploymentSubscriptionDetails'
        description: 'Associate a GoldenGate deployment with a different subscription.

          '
        required: true
  /deployments/{deploymentId}/actions/collectDiagnostics:
    post:
      description: 'Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: CollectDeploymentDiagnostic
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The Collect Deployment Diagnostic request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Collects the diagnostic of a Deployment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectDeploymentDiagnosticDetails'
        description: 'Metadata about the deployment diagnostic. This also includes the Object storage information where the diagnostic will be uploaded

          '
        required: true
  /deployments/{deploymentId}/actions/exportWallet:
    post:
      description: 'Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: ExportDeploymentWallet
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The export wallet from deployment request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Export the OGG wallet from the deployment to OCI vault
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportDeploymentWalletDetails'
        description: 'Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to

          '
        required: true
  /deployments/{deploymentId}/actions/generateDisasterRecoveryPrecheckReport:
    post:
      description: 'Generates disaster recovery precheck report for standby peer.

        '
      operationId: GenerateDisasterRecoveryPrecheckReport
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Precheck submitted. Track progress via the returned work request id.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Disaster Recovery precheck.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDisasterRecoveryPrecheckReportDetails'
        description: 'Parameters for the DR precheck report generation request.

          '
        required: true
  /deployments/{deploymentId}/actions/generateLibraryUrl:
    post:
      description: 'Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.

        '
      operationId: GenerateLibraryUrl
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'The generated Pre-Authenticated Request Object URL to a DB2 for z/OS library

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryUrl'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Generates a Pre-Authenticated Request Object URL to the DB2 for z/OS library.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateLibraryUrlDetails'
        description: 'A placeholder for any additional metadata to describe the request details.

          '
        required: true
  /deployments/{deploymentId}/actions/importWallet:
    post:
      description: 'Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: ImportDeploymentWallet
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The import wallet to deployment request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Imports an OGG wallet to the Deployment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportDeploymentWalletDetails'
        description: 'Metadata to import wallet to deployment. This also includes the OCI Vault information where the wallet will be imported from

          '
        required: true
  /deployments/{deploymentId}/actions/removeLocalPeer:
    post:
      description: 'Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: RemoveDeploymentLocalPeer
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The remove deployment peer request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Removes a local peer
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveDeploymentLocalPeerDetails'
        description: 'Metadata to remove a local deployment peer

          '
        required: true
  /deployments/{deploymentId}/actions/removeLock:
    post:
      description: Removes a lock from a Deployment resource.
      operationId: RemoveDeploymentLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned Deployment resource.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Removes a lock to a Deployment resource.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
  /deployments/{deploymentId}/actions/start:
    post:
      description: 'Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: StartDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The Start Deployment request was accepted.


            Note: This is an asynchronous operation. To determine the Deployment''s state, check the

            Deployment''s lifecycleState or work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Starts a Deployment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDeploymentDetails'
        description: 'A placeholder for any additional metadata to describe the deployment start.

          '
        required: true
  /deployments/{deploymentId}/actions/stop:
    post:
      description: 'Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: StopDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Request to stop Deployment accepted.


            Note: This is an asynchronous operation. To determine the Deployment''s state, check the

            Deployment''s lifecycleState or the work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stops a Deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopDeploymentDetails'
        description: 'A placeholder for any additional metadata to describe the deployment stop.

          '
        required: true
  /deployments/{deploymentId}/actions/switchover:
    post:
      description: 'Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: SwitchoverDeploymentPeer
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The switchover to peer from deployment request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Switchover to the deployment peer
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwitchoverDeploymentPeerDetails'
        description: 'Metadata to switchover a deployment to a peer

          '
        required: true
  /deployments/{deploymentId}/actions/upgrade:
    post:
      description: 'Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: UpgradeDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Request to upgrade Deployment accepted.


            Note: This is an asynchronous operation. To determine the Deployment''s state, check the

            Deployment''s lifecycleState or the work request identified by the opc-work-request-id

            returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Upgrade a Deployment to different version.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeDeploymentDetails'
        description: 'A placeholder for any additional metadata to describe the deployment upgrade.

          '
        required: true
  /deployments/{deploymentId}/actions/walletExists:
    post:
      description: 'Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: DeploymentWalletExists
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'Returns true if a wallet is already present in the deployment.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentWalletExistsResponseDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Checks if a wallet is already present in the deployment
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentWalletExistsDetails'
        description: 'A placeholder for any additional metadata to describe the deployment start.

          '
        required: true
  /deployments/{deploymentId}/certificates:
    get:
      description: Returns a list of certificates from truststore.
      operationId: ListCertificates
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CertificateLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'The Certificate collection from truststore was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of certificates from truststore.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/CertificateCollection'
    post:
      description: 'Creates a new certificate to truststore.

        '
      operationId: CreateCertificate
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Fully creating a Certificate is an asynchronous process,

            check the lifecycleState of the Certificate and/or the work request associated with the ocp-work-request-id

            returned in the header to determine the state of the Certificate.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new certificate to truststore.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/CertificateCollection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCertificateDetails'
        description: 'Specifications to create the certificate to truststore.

          '
        required: true
  /deployments/{deploymentId}/certificates/{certificateKey}:
    delete:
      description: 'Deletes the certificate from truststore.

        '
      operationId: DeleteCertificate
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/CertificateKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: Delete request accepted.
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the certificate from truststore.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Certificate'
    get:
      description: 'Retrieves a Certificate.

        '
      operationId: GetCertificate
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/CertificateKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Certificate was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Certificate.
      tags:
      - goldenGate
  /deployments/{deploymentId}/deploymentWalletsOperations:
    get:
      description: 'Lists the wallets export/import operations to/from a deployment.

        '
      operationId: ListDeploymentWalletsOperations
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/WalletSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: 'The wallets operations collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentWalletsOperationCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the wallets export/import operations to/from a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentWalletsOperationSummary'
  /deployments/{deploymentId}/disasterRecoveryPrecheckReport:
    get:
      description: 'Returns DR precheck report for a standby peer with the specified placement (availabilityDomain and faultDomain).

        '
      operationId: GetDisasterRecoveryPrecheckReport
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/FaultDomainQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Dr precheck result fetched successfully.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisasterRecoveryPrecheckReport'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns DR precheck report for a  standby peer.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Deployment'
  /deployments/{deploymentId}/peers:
    get:
      description: 'Lists the local and remote peers in a deployment.

        '
      operationId: ListDeploymentPeers
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/DeploymentPeerLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Successfully retrieved a collection of peers.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPeerCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the local and remote peers in a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/DeploymentPeerSummary'
  /messages:
    get:
      description: 'Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.

        '
      operationId: ListMessages
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: 'The DeploymentMessage collection was retrieved successfully.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentMessageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the DeploymentMessages for a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/MessageSummary'
  /pipelines:
    get:
      description: 'Lists the Pipelines in the compartment.

        '
      operationId: ListPipelines
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PipelineLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PipelineLifecycleSubStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Pipelines collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the Pipelines in the compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
    post:
      description: 'Creates a new Pipeline.

        '
      operationId: CreatePipeline
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'The Pipeline was created successfully.

            Note: Fully creating a Pipeline is an asynchronous process. To determine the

            state of the Pipeline, check the Pipeline''s lifecycleState

            and/or the work request associated with the opc-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePipelineDetails'
        description: 'Specification of the pipeline to create.

          '
        required: true
  /pipelines/actions/clone:
    post:
      description: 'Clones the pipeline.

        '
      operationId: ClonePipeline
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The Pipeline was cloned successfully.

            Note: Fully cloning a Pipeline is an asynchronous process. To determine the

            state of the Pipeline, check the Pipeline''s lifecycleState

            and/or the work request associated with the opc-work-request-id returned in the header.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a clone of the pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClonePipelineDetails'
        description: 'Details to clone the pipeline.

          '
        required: true
  /pipelines/{pipelineId}:
    delete:
      description: 'Deletes a Pipeline.

        '
      operationId: DeletePipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Delete request accepted.


            Note: This is an asynchronous operation. To determine the state of the delete operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
    get:
      description: 'Retrieves a Pipeline details.

        '
      operationId: GetPipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Pipeline was retrieved successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Pipeline details.
      tags:
      - goldenGate
    put:
      description: 'Updates the Pipeline.

        '
      operationId: UpdatePipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Update request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the Pipeline identified by the pipeline id.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePipelineDetails'
        description: 'The existing pipeline specifications to apply.

          '
        required: true
  /pipelines/{pipelineId}/actions/changeCompartment:
    post:
      description: 'Moves the Pipeline into a different compartment within the same tenancy. When

        provided, If-Match is checked against ETag values of the resource.  For information about

        moving resources between compartments, see [Moving Resources Between

        Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangePipelineCompartment
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Move request accepted.


            Note: This is an asynchronous operation. To determine the state of the move operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the Pipeline to a different compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePipelineCompartmentDetails'
        description: 'Properties to change the compartment of a Pipeline.

          '
        required: true
  /pipelines/{pipelineId}/actions/collectDiagnostics:
    post:
      description: 'Collects diagnostics for the pipeline

        '
      operationId: CollectPipelineDiagnostic
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Collect pipeline diagnostics request was accepted.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Collects diagnostics for the pipeline
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectPipelineDiagnosticDetails'
        description: 'Details for collecting the diagnostic. It includes the object storage information where the diagnostic will be uploaded.

          '
        required: true
  /pipelines/{pipelineId}/actions/pause:
    post:
      description: 'Pauses the pipeline.

        '
      operationId: PausePipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Pause Pipeline external attributes request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: pauses the pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PausePipelineDetails'
        description: 'Details to pause the pipeline.

          '
        required: true
  /pipelines/{pipelineId}/actions/start:
    post:
      description: 'Starts the pipeline for data replication.

        '
      operationId: StartPipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Start Pipeline external attributes request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Starts the pipeline for data replication.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartPipelineDetails'
        description: 'Details to start Pipeline.

          '
        required: true
  /pipelines/{pipelineId}/actions/stop:
    post:
      description: 'Stops the pipeline for data replication.

        '
      operationId: StopPipeline
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'Stop Pipeline external attributes request accepted.


            Note: This is an asynchronous operation. To determine the state of the update operation,

            check the Pipeline''s lifecycleState and/or the work request identified by

            the opc-work-request-id returned in the header.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

                status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stops the pipeline for data replication.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopPipelineDetails'
        description: 'Details to stop the pipeline.

          '
        required: true
  /pipelines/{pipelineId}/actions/testConnection:
    post:
      description: 'Tests pipeline connections against pipeline to verify the connectivity.

        When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: TestPipelineConnection
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: 'Test Action performed.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestPipelineConnectionResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Tests pipeline connections against pipeline to verify the connectivity.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestPipelineConnectionDetails'
        description: 'Additional metadata required to test the connection assigned to the pipeline.

          '
        required: true
  /pipelines/{pipelineId}/initializationSteps:
    get:
      description: 'Retrieves a Pipeline recipe steps and its progress details.

        '
      operationId: ListPipelineInitializationSteps
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Retrieved a Pipeline recipe steps and its progress details successfully.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineInitializationSteps'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Pipeline recipe steps and its progress details.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
  /pipelines/{pipelineId}/runningProcesses:
    get:
      description: 'Retrieves a Pipeline''s running replication process''s status like Capture/Apply.

        '
      operationId: ListPipelineRunningProcesses
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Retrieved a Pipeline''s running replication process''s status like Capture/Apply successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRunningProcessCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a Pipeline's running replication process's status like Capture/Apply.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
  /pipelines/{pipelineId}/schemaTables:
    get:
      description: 'Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.

        '
      operationId: ListPipelineSchemaTables
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/SourceSchemaNameQueryParam'
      - $ref: '#/components/parameters/TargetSchemaNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'Table list retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineSchemaTableCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get an array of tables under the given schemas passed as required source and target query params of the pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
  /pipelines/{pipelineId}/schemas:
    get:
      description: 'Returns an array of schemas based on mapping rules for a pipeline.

        '
      operationId: ListPipelineSchemas
      parameters:
      - $ref: '#/components/parameters/PipelineIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'Schema list retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineSchemaCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get an array of schemas based on mapping rules for a pipeline.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/Pipeline'
  /recipes:
    get:
      description: 'Returns an array of Recipe Summary.

        '
      operationId: ListRecipes
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RecipeTypeQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: 'Recipe list retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get available recipes supported by GoldenGate.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/RecipeSummaryCollection'
  /trailFiles:
    get:
      deprecated: true
      description: 'Lists the TrailFiles for a deployment.

        Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

        '
      operationId: ListTrailFiles
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/TrailFileIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/TrailSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: 'The TrailFile collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrailFileCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the TrailFiles for a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/TrailFileSummary'
  /trailSequences:
    get:
      deprecated: true
      description: 'Lists the Trail Sequences for a TrailFile in a given deployment.

        Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

        '
      operationId: ListTrailSequences
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierQueryParam'
      - $ref: '#/components/parameters/ReqTrailFileIdQueryParam'
      - $ref: '#/components/parameters/TrailSequenceIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/TrailSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: 'The TrailSequence collection was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrailSequenceCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of the Trail Sequences for a deployment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/TrailSequenceSummary'
  /workRequests:
    get:
      description: 'Lists the work requests in the compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ResourceIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'List of work requests was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/WorkRequest'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the work requests in the compartment.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: 'Retrieve the WorkRequest identified by the given OCID.

        '
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Work Request was retrieved successfully.

            '
          headers:
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
            retry-after:
              description: 'The number of seconds the client should wait before polling this endpoint again.

                '
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves a work request.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Lists work request errors.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'List of Work Request errors was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/WorkRequestError'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request errors.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Lists work request logs.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'List of Work Request logs was retrieved successfully.

            '
          headers:
            opc-next-page:
              description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
              schema:
                type: string
            opc-request-id:
              description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please include the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/WorkRequestLogEntry'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request logs.
      tags:
      - goldenGate
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  schemas:
    AiModelAuthType:
      description: 'Authentication type used by the AI model connection.

        '
      enum:
      - OCI_GEN_AI
      - API_KEY
      type: string
    TestConnectionAssignmentResult:
      description: 'The result of the connectivity test performed between the GoldenGate deployment and the associated database / service.

        The ''error'' property is deprecated and will not contain values in the future. So, the error(s) will be returned in just the ''errors'' property.

        '
      properties:
        error:
          $ref: '#/components/schemas/TestConnectionAssignmentError'
        errors:
          description: 'List of test connection assignment error objects.

            '
          items:
            $ref: '#/components/schemas/TestConnectionAssignmentError'
          type: array
        resultType:
          description: 'Type of the result (i.e. Success, Failure or Timeout).

            '
          enum:
          - SUCCEEDED
          - FAILED
          - TIMED_OUT
          type: string
      required:
      - resultType
      type: object
      x-example: "{\n  \"resultType\": FAILED,\n  \"error\": {\n    \"code\": \"OGG-08110\",\n    \"message\": \"The database server is not reachable.\",\n    \"issue\": \"Login failed. Unable to connect to database using user ggadmin@(DESCRIPTION=(TRANSPORT_CONNECT_TIMEOUT=3)(CONNECT_TIMEOUT=60)(RECV_TIMEOUT=120)(retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us-sanjose-1.oraclecloud.com))(CONNECT_DATA=(COLOCATION_TAG=OracleDB)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC)(OVERRIDE=TRUE))(service_name=g6e398eb54f71b8_apple_low.adb.oraclecloud.com))(security=(MY_WALLET_DIRECTORY=\\\"/u02/connections/ocid1.goldengateconnection.oc1.us-sanjose-1.amaaaaaarhwbfeqaattj7qqcglswxlcsft6azjwbmvamo5sl3cscy72infsq/wallet\\\")(SSL_SERVER_DN_MATCH=TRUE)(ssl_server_dn_match=yes))). Ensure that the necessary privileges are granted to the user.\\nOCI Error ORA (status = 1017-ORA-01017: invalid username/password; logon denied\\n)\",\n     \"action\": \"Ensure that the necessary privileges are granted to the user.\"\n  }\n    ,\n  \"errors\" : [\n    {error object},\n    {error object}\n  ]\n}\n"
    UpdateOggDeploymentDetails:
      description: 'Deployment Details for updating an OggDeployment

        '
      properties:
        adminPassword:
          description: 'The password associated with the GoldenGate deployment console username.

            The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric,

            and 1 special character. Special characters such as ''$'', ''^'', or ''?'' are not allowed.

            This field will be deprecated and replaced by "passwordSecretId".

            '
          example: secret-A1
          format: password
          maxLength: 30
          minLength: 1
          pattern: (?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*
          type: string
        adminUsername:
          description: 'The GoldenGate deployment console username.

            '
          example: oggadmin
          maxLength: 512
          minLength: 0
          type: string
        certificate:
          description: 'The base64 encoded content of the PEM file containing the SSL certificate.

            '
          maxLength: 65536
          minLength: 0
          type: string
        credentialStore:
          default: GOLDENGATE
          description: 'The type of credential store for OGG.

            '
          enum:
          - GOLDENGATE
          - IAM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialStore'
        groupToRolesMapping:
          $ref: '#/components/schemas/UpdateGroupToRolesMappingDetails'
        identityDomainId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: 'The base64 encoded content of the PEM file containing the private key.

            '
          format: password
          maxLength: 8192
          minLength: 0
          type: string
        keySecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format.

            '
          maxLength: 255
          minLength: 0
          type: string
        passwordSecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    DatabaseRegistrationSummary:
      description: 'Summary of the DatabaseRegistration.

        '
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionString:
          description: 'Connect descriptor or Easy Connect Naming method used to connect to a database.

            '
          maxLength: 2000
          minLength: 1
          type: string
        databaseId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the databaseRegistration being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          - IN_PROGRESS
          - CANCELING
          - CANCELED
          - SUCCEEDED
          - WAITING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        secretId:
          description: "The OCID of the customer's GoldenGate Service Secret. \nIf provided, it references a key that customers will be required to ensure the policies are established \nto permit GoldenGate to use this Secret.\n"
          maxLength: 255
          minLength: 1
          type: string
        sessionMode:
          default: DIRECT
          description: 'The mode of the database connection session to be established by the data client.

            ''REDIRECT'' - for a RAC database, ''DIRECT'' - for a non-RAC database.

            Connection to a RAC database involves a redirection received from the SCAN listeners

            to the database node to connect to. By default the mode would be DIRECT.

            '
          enum:
          - DIRECT
          - REDIRECT
          type: string
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        username:
          description: 'The username Oracle GoldenGate uses to connect the associated system of the given technology.

            This username must already exist and be available by the system/application to be connected to

            and must conform to the case sensitivty requirments defined in it.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - fqdn
      type: object
    UpdateDatabaseRegistrationDetails:
      description: 'The information to update a DatabaseRegistration.

        '
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        connectionString:
          description: 'Connect descriptor or Easy Connect Naming method used to connect to a database.

            '
          maxLength: 2000
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        password:
          description: 'The password Oracle GoldenGate uses to connect the associated system of the given technology.

            It must conform to the specific security requirements including length, case sensitivity, and so on.

            Deprecated: This field is deprecated and replaced by "passwordSecretId".

            This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

            '
          format: password
          maxLength: 255
          minLength: 0
          type: string
        sessionMode:
          default: DIRECT
          description: 'The mode of the database connection session to be established by the data client.

            ''REDIRECT'' - for a RAC database, ''DIRECT'' - for a non-RAC database.

            Connection to a RAC database involves a redirection received from the SCAN listeners

            to the database node to connect to. By default the mode would be DIRECT.

            '
          enum:
          - DIRECT
          - REDIRECT
          type: string
        username:
          description: 'The username Oracle GoldenGate uses to connect the associated system of the given technology.

            This username must already exist and be available by the system/application to be connected to

            and must conform to the case sensitivty requirments defined in it.

            '
          maxLength: 255
          minLength: 0
          type: string
        wallet:
          description: 'The wallet contents Oracle GoldenGate uses to make connections to a database.

            This attribute is expected to be base64 encoded.

            Deprecated: This field is deprecated and replaced by "walletSecretId".

            This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

            '
          format: password
          maxLength: 51200
          minLength: 0
          type: string
      type: object
    ConnectionAssignment:
      description: 'Represents the metadata description of a connection assignment.

        Before you can use a connection as a GoldenGate source or target, you must assign it to a deployment.

        '
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection assignment being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Possible lifecycle states for connection assignments.
          enum:
          - CREATING
          - ACTIVE
          - FAILED
          - UPDATING
          - DELETING
          type: string
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - connectionId
      - connectionType
      - deploymentId
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    Error:
      description: 'Error information.

        '
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing.

            '
          type: string
        message:
          description: 'A human-readable error string.

            '
          type: string
      required:
      - code
      - message
    CreateMaintenanceConfigurationDetails:
      description: 'Defines the maintenance configuration for create operation.

        '
      properties:
        bundleReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.

            This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        interimReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.

            '
          minimum: 0
          type: integer
        isInterimReleaseAutoUpgradeEnabled:
          description: "By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, \nyou have to specify interimReleaseUpgradePeriodInDays too.\n"
          type: boolean
        majorReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        securityPatchUpgradePeriodInDays:
          description: 'Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
      type: object
    DeploymentPlacementInfo:
      description: 'Specifies a deployment placement with explicit availability and fault domain specification.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
      required:
      - availabilityDomain
      - faultDomain
      type: object
    Pipeline:
      description: 'Represents the metadata details of a pipeline in the same compartment.

        '
      discriminator:
        propertyName: recipeType
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.

            '
          maxLength: 255
          minLength: 1
          type: string
        ingressIps:
          description: "List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. \nCustomers may optionally set up ingress security rules to restrict traffic from these IP addresses.\n"
          items:
            $ref: '#/components/schemas/IngressIpDetails'
          type: array
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Lifecycle state of the pipeline.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - NEEDS_ATTENTION
          - DELETING
          - DELETED
          - FAILED
          - INACTIVE
          type: string
        lifecycleSubState:
          description: 'Possible lifecycle substates when retrieving a pipeline.

            '
          enum:
          - STARTING
          - STOPPING
          - STOPPED
          - MOVING
          - RUNNING
          - PAUSING
          - PAUSED
          - START_FAILED
          - STOP_FAILED
          - PAUSE_FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleSubState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        pipelineDiagnosticData:
          $ref: '#/components/schemas/PipelineDiagnosticData'
        recipeType:
          description: 'The type of the recipe

            '
          enum:
          - ZERO_ETL
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecipeType'
        sourceConnectionDetails:
          $ref: '#/components/schemas/SourcePipelineConnectionDetails'
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline''s private endpoint.

            The subnet must be a private subnet.

            '
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        targetConnectionDetails:
          $ref: '#/components/schemas/TargetPipelineConnectionDetails'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - recipeType
      - id
      - displayName
      - compartmentId
      - lifecycleState
      - timeCreated
      - timeUpdated
      - licenseModel
      - cpuCoreCount
      - isAutoScalingEnabled
      - sourceConnectionDetails
      - targetConnectionDetails
      type: object
    Connection:
      description: 'Represents the metadata description of a connection used by deployments in the same compartment.

        '
      discriminator:
        propertyName: connectionType
      properties:
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        doesUseSecretIds:
          default: false
          description: 'Indicates that sensitive attributes are provided via Secrets.


            Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID

            attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes. This change follows

            the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            When set to `true`, all sensitive information must be provided as OCI Vault secrets using the corresponding

            `*SecretId` attributes of the connection (for example, `passwordSecretId`). Plain-text sensitive attributes (for example, `password`) must not be used.

            This ensures that sensitive information remains stored and managed in the customer''s OCI Vault rather than by the GoldenGate service.


            When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, `password`) rather than in secret OCID attributes.

            In this mode, the sensitive information is stored by the GoldenGate service. If `vaultId` and `keyId` are not specified,

            the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.


            If `vaultId` and `keyId` are provided, the specified customer-managed key is used.

            '
          type: boolean
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        ingressIps:
          description: "List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. \nCustomers may optionally set up ingress security rules to restrict traffic from these IP addresses.\n"
          items:
            $ref: '#/components/schemas/IngressIpDetails'
          type: array
          x-default-description: 'null'
        keyId:
          description: 'References the OCI Vault key in the OCI Vault identified by `vaultId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API.

            This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided,

            the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data.

            If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.

            '
          maxLength: 255
          minLength: 0
          type: string
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for connection.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        routingMethod:
          description: "Controls the network traffic direction to the target:\nSHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.\nDEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.\nSHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. \n\nDeprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method.\nThis change follows the GoldenGate \"Plain Text Fields in Connections\" deprecation:\nhttps://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate\n"
          enum:
          - SHARED_SERVICE_ENDPOINT
          - SHARED_DEPLOYMENT_ENDPOINT
          - DEDICATED_ENDPOINT
          type: string
          x-default-description: 'null'
          x-obmcs-top-level-enum: '#/definitions/RoutingMethod'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        vaultId:
          description: 'References the OCI Vault that contains the customer-managed encryption key identified by `keyId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            This field is applicable only when `doesUseSecretIds` is set to `false`.

            If `vaultId` is provided, `keyId` must also be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - connectionType
      - id
      - displayName
      - compartmentId
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    TrailSequenceCollection:
      description: 'A list of TrailSequences.

        '
      properties:
        items:
          description: 'An array of TrailSequences.

            '
          items:
            $ref: '#/components/schemas/TrailSequenceSummary'
          type: array
        timeLastFetched:
          description: 'The time the data was last fetched from the deployment. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - timeLastFetched
      - items
      type: object
    CertificateCollection:
      description: A list of Certificates.
      properties:
        items:
          description: 'An array of Certificates.

            '
          items:
            $ref: '#/components/schemas/CertificateSummary'
          type: array
      required:
      - items
      type: object
    RemoveDeploymentLocalPeerDetails:
      description: 'The information about removing a deployment peer.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
      required:
      - availabilityDomain
      - faultDomain
      type: object
    PipelineSchemaTableSummary:
      description: 'Summary of source or target schema tables of a pipeline''s assigned connection.

        1. If there is no explicit mapping defined for the pipeline then only matched source and target schema''s table names will be returned

        2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema''s table names, the matched source and target schema''s table names also will be returned.

        '
      properties:
        sourceTableName:
          description: 'The table name from the schema of database connection.

            '
          example: EMPLOYEE or ADDRESS
          minLength: 2
          type: string
        targetTableName:
          description: 'The table name from the schema of database connection.

            '
          example: EMPLOYEE or ADDRESS
          minLength: 2
          type: string
      required:
      - sourceTableName
      - targetTableName
      type: object
    SnoozeDeploymentUpgradeDetails:
      description: The information about the snooze for a deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deploymentUpgrade snooze.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/SnoozeDeploymentUpgradeType'
      required:
      - type
      type: object
    CreatePipelineDetails:
      description: 'Details with which to create a pipeline.

        '
      discriminator:
        propertyName: recipeType
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        recipeType:
          description: 'The type of the recipe

            '
          enum:
          - ZERO_ETL
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecipeType'
        sourceConnectionDetails:
          $ref: '#/components/schemas/SourcePipelineConnectionDetails'
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline''s private endpoint.

            The subnet must be a private subnet.

            '
          maxLength: 255
          minLength: 0
          type: string
        targetConnectionDetails:
          $ref: '#/components/schemas/TargetPipelineConnectionDetails'
      required:
      - recipeType
      - displayName
      - compartmentId
      - licenseModel
      - sourceConnectionDetails
      - targetConnectionDetails
      type: object
    CancelDeploymentUpgradeDetails:
      description: The information about canceling.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deploymentUpgrade cancel.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/CancelDeploymentUpgradeType'
      required:
      - type
      type: object
    DeploymentBackupCollection:
      description: 'A list of DeploymentBackups.

        '
      properties:
        items:
          description: 'An array of DeploymentBackups.

            '
          items:
            $ref: '#/components/schemas/DeploymentBackupSummary'
          type: array
      required:
      - items
      type: object
    DeploymentTypeSummary:
      description: 'The meta-data specific on particular deployment type represented by deploymentType field.


        Deprecated properties: `sourceTechnologies` and `targetTechnologies` are not populated. They will be removed after September 15 2025.

        The list of supported source and target technologies can be accessed using the url provided in `supportedTechnologiesUrl` property.

        '
      properties:
        category:
          description: 'The deployment category defines the broad separation of the deployment type into four categories.

            Currently the separation is ''DATA_REPLICATION'', ''STREAM_ANALYTICS'', ''DATA_TRANSFORMS'' and ''DATA_VERIFICATION''.

            '
          enum:
          - DATA_REPLICATION
          - STREAM_ANALYTICS
          - DATA_TRANSFORMS
          - DATA_VERIFICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentCategory'
        connectionTypes:
          description: 'An array of connectionTypes.

            '
          items:
            enum:
            - GOLDENGATE
            - KAFKA
            - KAFKA_SCHEMA_REGISTRY
            - MYSQL
            - JAVA_MESSAGE_SERVICE
            - MICROSOFT_SQLSERVER
            - OCI_OBJECT_STORAGE
            - ORACLE
            - AZURE_DATA_LAKE_STORAGE
            - POSTGRESQL
            - AZURE_SYNAPSE_ANALYTICS
            - SNOWFLAKE
            - AMAZON_S3
            - HDFS
            - ORACLE_AI_DATA_PLATFORM
            - ORACLE_NOSQL
            - MONGODB
            - AMAZON_KINESIS
            - AMAZON_REDSHIFT
            - DB2
            - REDIS
            - ELASTICSEARCH
            - GENERIC
            - GOOGLE_CLOUD_STORAGE
            - GOOGLE_BIGQUERY
            - DATABRICKS
            - GOOGLE_PUBSUB
            - MICROSOFT_FABRIC
            - ICEBERG
            - AI_MODEL
            type: string
            x-obmcs-top-level-enum: '#/definitions/ConnectionType'
          type: array
        defaultUsername:
          description: 'The default admin username used by deployment.

            '
          type: string
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        sourceTechnologies:
          description: 'List of the supported technologies generally.  The value is a freeform text string generally consisting

            of a description of the technology and optionally the speific version(s) support.  For example,

            [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ]

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        supportedCapabilities:
          description: 'Specifies supported capabilities or features by a deployment type .

            '
          items:
            enum:
            - GROUP_TO_ROLE
            - BACKUP_RESTORE
            - COPY_BACKUP
            - MANUAL_BACKUP
            - PLACEMENT
            - DISASTER_RECOVERY
            - SCHEDULE_MANUAL_BACKUP
            - MULTICLOUD
            - TRAIL_FILES
            - MASTER_KEY_OPERATIONS
            - TRUSTSTORE_CERTIFICATES
            - DEPLOYMENT_DIAGNOSTICS
            - CREDENTIALS
            - CONSOLE_ACCESS
            - NETWORK_CONFIGURATION
            type: string
            x-obmcs-top-level-enum: '#/definitions/SupportedCapabilities'
          type: array
        supportedLicenseTypes:
          description: 'The list of Oracle license models supported by the deployment type.

            '
          items:
            $ref: '#/components/schemas/LicenseModel'
          type: array
        supportedTechnologiesUrl:
          description: 'The URL to the webpage listing the supported technologies.

            '
          type: string
        targetTechnologies:
          description: 'List of the supported technologies generally.  The value is a freeform text string generally consisting

            of a description of the technology and optionally the speific version(s) support.  For example,

            [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ]

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
      required:
      - category
      - displayName
      - deploymentType
      type: object
    IngressIpDetails:
      description: 'Private Endpoint IP Addresses created in the customer''s subnet.

        GoldenGate service will use these ingress IP addresses to send all specific requests initiated from the service.

        These are typically used for accessing customer resources.

        '
      properties:
        ingressIp:
          description: 'A Private Endpoint IPv4 or IPv6 Address created in the customer''s subnet.

            '
          maxLength: 46
          minLength: 1
          type: string
      required:
      - ingressIp
      type: object
    DeploymentVersionCollection:
      description: 'The list of DeploymentVersionSummary objects.

        '
      properties:
        items:
          description: 'Array of DeploymentVersionSummary.

            '
          items:
            $ref: '#/components/schemas/DeploymentVersionSummary'
          type: array
      required:
      - items
      type: object
    CreateConnectionDetails:
      description: 'The information about a new Connection.

        '
      discriminator:
        propertyName: connectionType
      properties:
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        doesUseSecretIds:
          default: false
          description: 'Indicates that sensitive attributes are provided via Secrets.


            Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID

            attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes. This change follows

            the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            When set to `true`, all sensitive information must be provided as OCI Vault secrets using the corresponding

            `*SecretId` attributes of the connection (for example, `passwordSecretId`). Plain-text sensitive attributes (for example, `password`) must not be used.

            This ensures that sensitive information remains stored and managed in the customer''s OCI Vault rather than by the GoldenGate service.


            When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, `password`) rather than in secret OCID attributes.

            In this mode, the sensitive information is stored by the GoldenGate service. If `vaultId` and `keyId` are not specified,

            the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.


            If `vaultId` and `keyId` are provided, the specified customer-managed key is used.

            '
          type: boolean
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        keyId:
          description: 'References the OCI Vault key in the OCI Vault identified by `vaultId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API.

            This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided,

            the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data.

            If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.

            '
          maxLength: 255
          minLength: 0
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/AddResourceLockDetails'
          maxItems: 1
          type: array
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        routingMethod:
          description: "Controls the network traffic direction to the target:\nSHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.\nDEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.\nSHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. \n\nDeprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method.\nThis change follows the GoldenGate \"Plain Text Fields in Connections\" deprecation:\nhttps://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate\n"
          enum:
          - SHARED_SERVICE_ENDPOINT
          - SHARED_DEPLOYMENT_ENDPOINT
          - DEDICATED_ENDPOINT
          type: string
          x-default-description: 'null'
          x-obmcs-top-level-enum: '#/definitions/RoutingMethod'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        vaultId:
          description: 'References the OCI Vault that contains the customer-managed encryption key identified by `keyId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            This field is applicable only when `doesUseSecretIds` is set to `false`.

            If `vaultId` is provided, `keyId` must also be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - connectionType
      - displayName
      - compartmentId
      type: object
    UpdatePipelineDetails:
      description: 'Information with which to update a pipeline.

        '
      discriminator:
        propertyName: recipeType
      properties:
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        recipeType:
          description: 'The type of the recipe

            '
          enum:
          - ZERO_ETL
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecipeType'
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline''s private endpoint.

            The subnet must be a private subnet.

            '
          maxLength: 255
          minLength: 0
          type: string
      type: string
    OggDeployment:
      description: 'Deployment Data for an OggDeployment

        '
      properties:
        adminUsername:
          description: 'The GoldenGate deployment console username.

            '
          example: oggadmin
          maxLength: 512
          minLength: 0
          type: string
        certificate:
          description: 'The base64 encoded content of the PEM file containing the SSL certificate.

            '
          maxLength: 65536
          minLength: 0
          type: string
        credentialStore:
          default: GOLDENGATE
          description: 'The type of credential store for OGG.

            '
          enum:
          - GOLDENGATE
          - IAM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialStore'
        deploymentName:
          description: 'The name given to the GoldenGate service deployment.

            The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.

            '
          maxLength: 32
          minLength: 1
          pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
          type: string
        groupToRolesMapping:
          $ref: '#/components/schemas/GroupToRolesMappingDetails'
        identityDomainId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.

            '
          maxLength: 255
          minLength: 1
          type: string
        keySecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format.

            '
          maxLength: 255
          minLength: 0
          type: string
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        passwordSecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - deploymentName
      - adminUsername
      type: object
    TestPipelineConnectionError:
      allOf:
      - $ref: '#/components/schemas/TestConnectionAssignmentError'
      description: 'The error returned when a pipeline connection fails to connect.

        '
      type: object
    CertificateSummary:
      description: Summary of the Certificates.
      properties:
        isSelfSigned:
          description: 'Indicates if the certificate is self signed.

            '
          type: boolean
        key:
          description: "The identifier key (unique name in the scope of the deployment) of the certificate being referenced. \nIt must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.\n"
          maxLength: 32
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible certificate lifecycle states.

            '
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState'
        subject:
          description: 'The Certificate subject.

            '
          example: 'C=AA,O=AAAA,OU=AAAA,CN=AAAA

            '
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeValidTo:
          description: 'The time the certificate is valid to. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - key
      - lifecycleState
      - subject
      - isSelfSigned
      - timeValidTo
      - timeCreated
      type: object
    ClonePipelineDetails:
      description: 'Details for a pipeline clone.

        '
      discriminator:
        propertyName: type
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        sourcePipelineId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.

            '
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        type:
          description: 'Type of a pipeline clone. This option applies when cloning a pipeline.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/ClonePipelineType'
      required:
      - type
      - displayName
      - sourcePipelineId
      - compartmentId
      type: object
    DisasterRecoveryPrecheckReport:
      description: 'DR precheck result for standby peer in the specified placement (availabilityDomain and faultDomain).

        '
      properties:
        checks:
          description: 'A list of precheck results.

            '
          items:
            $ref: '#/components/schemas/DisasterRecoveryPrecheckResult'
          maxItems: 100
          type: array
        precheckStatus:
          description: Status of the DR precheck result.
          enum:
          - SUCCEEDED
          - IN_PROGRESS
          - FAILED
          - NEEDS_ATTENTION
          type: string
          x-obmcs-top-level-enum: '#/definitions/PrecheckStatus'
        timePrecheckFinished:
          description: 'The timestamp when pre-check operation finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

            '
          format: date-time
          type: string
        timePrecheckStarted:
          description: 'The timestamp when pre-check started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - timePrecheckStarted
      - timePrecheckFinished
      - precheckStatus
      - checks
      type: object
    DatabaseRegistration:
      description: 'Represents the metadata description of a database used by deployments in the same compartment.

        '
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced as the successor resource of the deprecated database registration.

            '
          maxLength: 255
          minLength: 0
          type: string
        connectionString:
          description: 'Connect descriptor or Easy Connect Naming method used to connect to a database.

            '
          maxLength: 2000
          minLength: 1
          type: string
        databaseId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the databaseRegistration being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        ipAddress:
          description: 'The private IP address in the customer''s VCN of the customer''s endpoint, typically a

            database.

            '
          maxLength: 46
          minLength: 0
          type: string
        keyId:
          description: "Refers to the customer's master key OCID. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 0
          type: string
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          - IN_PROGRESS
          - CANCELING
          - CANCELED
          - SUCCEEDED
          - WAITING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        rcePrivateIp:
          description: "A Private Endpoint IP address created in the customer's subnet. \nA customer database can expect network traffic initiated by GoldenGate Service from this IP address. \nIt can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. \nThe customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.\n"
          maxLength: 46
          minLength: 1
          type: string
        secretCompartmentId:
          description: "The OCID of the compartment where the GoldenGate Secret will be created. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 1
          type: string
        secretId:
          description: "The OCID of the customer's GoldenGate Service Secret. \nIf provided, it references a key that customers will be required to ensure the policies are established \nto permit GoldenGate to use this Secret.\n"
          maxLength: 255
          minLength: 1
          type: string
        sessionMode:
          default: DIRECT
          description: 'The mode of the database connection session to be established by the data client.

            ''REDIRECT'' - for a RAC database, ''DIRECT'' - for a non-RAC database.

            Connection to a RAC database involves a redirection received from the SCAN listeners

            to the database node to connect to. By default the mode would be DIRECT.

            '
          enum:
          - DIRECT
          - REDIRECT
          type: string
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        username:
          description: 'The username Oracle GoldenGate uses to connect the associated system of the given technology.

            This username must already exist and be available by the system/application to be connected to

            and must conform to the case sensitivty requirments defined in it.

            '
          maxLength: 255
          minLength: 0
          type: string
        vaultId:
          description: "Refers to the customer's vault OCID. \nIf provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate\nto manage secrets contained within this vault.\n"
          maxLength: 255
          minLength: 0
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - fqdn
      - ipAddress
      - aliasName
      - username
      type: object
    TrailFileCollection:
      description: 'A list of TrailFiles.

        '
      properties:
        items:
          description: 'An array of TrailFiles.

            '
          items:
            $ref: '#/components/schemas/TrailFileSummary'
          type: array
        timeLastFetched:
          description: 'The time the data was last fetched from the deployment. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - timeLastFetched
      - items
      type: object
    MaintenanceConfiguration:
      description: 'Attributes for configuring automatic deployment maintenance.

        '
      properties:
        bundleReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.

            This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        interimReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.

            '
          minimum: 0
          type: integer
        isInterimReleaseAutoUpgradeEnabled:
          description: "By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, \nyou have to specify interimReleaseUpgradePeriodInDays too.\n"
          type: boolean
        majorReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        securityPatchUpgradePeriodInDays:
          description: 'Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
      required:
      - isInterimReleaseAutoUpgradeEnabled
      - bundleReleaseUpgradePeriodInDays
      - majorReleaseUpgradePeriodInDays
      - securityPatchUpgradePeriodInDays
      type: object
    CancelDeploymentBackupDetails:
      description: The information about the Cancel for a DeploymentBackup.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment backup cancel

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/CancelDeploymentBackupType'
      required:
      - type
      type: object
    TestPipelineConnectionResult:
      description: 'Result of the connectivity test performed on a pipeline''s assigned connection.

        '
      properties:
        error:
          $ref: '#/components/schemas/TestPipelineConnectionError'
        resultType:
          description: 'Type of result, either Succeeded, Failed, or Timed out.

            '
          enum:
          - SUCCEEDED
          - FAILED
          - TIMED_OUT
          type: string
      required:
      - resultType
      type: object
      x-example: "{\n   \"resultType\": FAILED,\n   \"error\": {\n     \"code\": \"OGG-08110\",\n     \"message\": \"The database server is not reachable.\",\n     \"issue\": \"Login failed. Unable to connect to database using user ggadmin@(DESCRIPTION=(TRANSPORT_CONNECT_TIMEOUT=3)(CONNECT_TIMEOUT=60)(RECV_TIMEOUT=120)(retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us-sanjose-1.oraclecloud.com))(CONNECT_DATA=(COLOCATION_TAG=OracleDB)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC)(OVERRIDE=TRUE))(service_name=g6e398eb54f71b8_apple_low.adb.oraclecloud.com))(security=(MY_WALLET_DIRECTORY=\\\"/u02/connections/ocid1.goldengateconnection.oc1.us-sanjose-1.amaaaaaarhwbfeqaattj7qqcglswxlcsft6azjwbmvamo5sl3cscy72infsq/wallet\\\")(SSL_SERVER_DN_MATCH=TRUE)(ssl_server_dn_match=yes))). Ensure that the necessary privileges are granted to the user.\\nOCI Error ORA (status = 1017-ORA-01017: invalid username/password; logon denied\\n)\",\n     \"action\": \"Ensure that the necessary privileges are granted to the user.\"\n   }      \n}\n"
    DeploymentMessageCollection:
      description: 'A list of DeploymentMessages.

        '
      properties:
        items:
          description: 'An array of DeploymentMessages.

            '
          items:
            $ref: '#/components/schemas/MessageSummary'
          type: array
      required:
      - items
      type: object
    DeploymentWalletsOperationSummary:
      description: 'Summary of the deployment wallets operations.

        '
      properties:
        deploymentWalletOperationStatus:
          description: 'The status of the deployment wallet.

            '
          enum:
          - EXPORTING
          - EXPORTED
          - IMPORTED
          - IMPORTING
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentWalletStatus'
        deploymentWalletOperationType:
          description: 'The operation type of the deployment wallet.

            '
          enum:
          - EXPORT
          - IMPORT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentWalletOperationType'
        timeCompleted:
          description: 'The date and time the request was finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        walletOperationId:
          description: 'The UUID of the wallet operation performed by the customer.

            If provided, this will reference a key which the customer can use to query or search a particular wallet operation

            '
          maxLength: 255
          minLength: 1
          type: string
        walletSecretId:
          description: "The OCID of the customer's GoldenGate Service Secret. \nIf provided, it references a key that customers will be required to ensure the policies are established \nto permit GoldenGate to use this Secret.\n"
          maxLength: 255
          minLength: 1
          type: string
      required:
      - walletOperationId
      - walletSecretId
      - deploymentWalletOperationType
      - deploymentWalletOperationStatus
      - timeStarted
      type: object
    CreateDeploymentDetails:
      description: 'The information about a new Deployment.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        backupSchedule:
          $ref: '#/components/schemas/CreateBackupScheduleDetails'
        byolCpuCoreCountLimit:
          description: 'The maximum number of CPUs allowed with a ''Bring Your Own License'' (BYOL) license type.

            Any CPU usage above this limit is considered as License Included and billed.

            '
          minimum: 1
          type: integer
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentBackupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        disasterRecoveryStatus:
          description: 'Indicates if disaster recovery is enabled for a deployment.

            If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DisasterRecoveryStatus'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        environmentType:
          description: 'Specifies whether the deployment is used in a production or development/testing environment.

            '
          enum:
          - PRODUCTION
          - DEVELOPMENT_OR_TESTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        isByolCpuCoreCountLimitEnabled:
          default: false
          description: 'Flag to allow to configure the ''Bring Your Own License'' (BYOL) license type CPU limit.

            If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

            '
          type: boolean
        isPublic:
          description: 'True if this object is publicly available.

            '
          type: boolean
          x-default-description: false
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        loadBalancerSubnetId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.\n\nRules:\n- Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.\n- Update:\n  - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).\n  - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.\n\nValidation:\n- Must reference a public subnet.\n- Must be a regional subnet.\n- Must be in the same VCN as subnetId.\n"
          maxLength: 255
          minLength: 0
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/AddResourceLockDetails'
          maxItems: 1
          type: array
        maintenanceConfiguration:
          $ref: '#/components/schemas/CreateMaintenanceConfigurationDetails'
        maintenanceWindow:
          $ref: '#/components/schemas/CreateMaintenanceWindowDetails'
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        oggData:
          $ref: '#/components/schemas/CreateOggDeploymentDetails'
        placements:
          description: 'An array of local peers of deployment

            '
          items:
            $ref: '#/components/schemas/DeploymentPlacementDetails'
          type: array
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        sourceDeploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the deployment''s private endpoint.

            The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,

            after which the private subnet will be enforced.

            '
          maxLength: 255
          minLength: 1
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
      required:
      - displayName
      - compartmentId
      - subnetId
      type: object
    CollectPipelineDiagnosticDetails:
      description: 'Details for collecting pipeline diagnostics

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        diagnosticNamePrefix:
          description: Name of the diagnostic collected and uploaded to object storage
          type: string
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
      required:
      - namespaceName
      - bucketName
      type: object
    TestConnectionAssignmentError:
      description: 'Error Information.

        '
      properties:
        action:
          description: 'The text describing the action required to fix the issue.

            '
          type: string
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing.

            '
          type: string
        issue:
          description: 'The text describing the root cause of the reported issue.

            '
          type: string
        message:
          description: 'A human-readable error string.

            '
          type: string
      required:
      - code
      - message
      x-example: "{\n  \"code\": \"OGG-08110\",\n  \"message\": \"The database server is not reachable.\",\n  \"issue\": \"Login failed. Unable to connect to database using user ggadmin@(DESCRIPTION=(TRANSPORT_CONNECT_TIMEOUT=3)(CONNECT_TIMEOUT=60)(RECV_TIMEOUT=120)(retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us-sanjose-1.oraclecloud.com))(CONNECT_DATA=(COLOCATION_TAG=OracleDB)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC)(OVERRIDE=TRUE))(service_name=g6e398eb54f71b8_apple_low.adb.oraclecloud.com))(security=(MY_WALLET_DIRECTORY=\\\"/u02/connections/ocid1.goldengateconnection.oc1.us-sanjose-1.amaaaaaarhwbfeqaattj7qqcglswxlcsft6azjwbmvamo5sl3cscy72infsq/wallet\\\")(SSL_SERVER_DN_MATCH=TRUE)(ssl_server_dn_match=yes))). Ensure that the necessary privileges are granted to the user.\\nOCI Error ORA (status = 1017-ORA-01017: invalid username/password; logon denied\\n)\",\n  \"action\": \"Ensure that the necessary privileges are granted to the user.\"\n}\n"
    AiProviderSummary:
      description: 'Summary details of an AI provider and its supported models.

        '
      properties:
        authType:
          description: 'Authentication types supported by the AI provider.

            '
          items:
            $ref: '#/components/schemas/AiModelAuthType'
          type: array
        defaultBaseUrl:
          description: 'Default base URL for the AI provider.

            '
          maxLength: 1024
          minLength: 1
          type: string
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        models:
          description: 'List of AI models supported by this provider, when available. This

            field is null when the provider''s models can be retrieved only after

            supplying additional context. For example, OCI_GENERATIVE_AI model

            availability may vary by region.

            '
          items:
            $ref: '#/components/schemas/AiModelSummary'
          maxItems: 100
          type: array
        providerType:
          description: 'AI Provider type used by the AI Model Connection.

            '
          enum:
          - OCI_GENERATIVE_AI
          - GEMINI
          - OPEN_AI
          - VOYAGE_AI
          type: string
      required:
      - providerType
      - displayName
      - authType
      - defaultBaseUrl
      - description
      type: object
    DeploymentUpgradeSummary:
      description: 'Summary of the Deployment Upgrade.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentUpgradeType:
          description: 'The type of the deployment upgrade: MANUAL or AUTOMATIC

            '
          enum:
          - MANUAL
          - AUTOMATIC
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentUpgradeType'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isCancelAllowed:
          description: "Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service, \notherwise only reschedule allowed.\n"
          type: boolean
        isRescheduleAllowed:
          description: 'Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.

            '
          type: boolean
        isRollbackAllowed:
          description: 'Indicates if rollback is allowed. In practice only the last upgrade can be rolled back.

            - Manual upgrade is allowed to rollback only until the old version isn''t deprecated yet.

            - Automatic upgrade by default is not allowed, unless a serious issue does not justify.

            '
          type: boolean
        isSecurityFix:
          description: 'Indicates if OGG release contains security fix.

            '
          type: boolean
        isSnoozed:
          description: 'Indicates if upgrade notifications are snoozed or not.

            '
          type: boolean
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment Upgrade.

            '
          type: string
          x-obmcs-enumref: '#/definitions/DeploymentUpgrade/lifecycleState'
        lifecycleSubState:
          description: 'Possible GGS lifecycle sub-states.

            '
          enum:
          - RECOVERING
          - STARTING
          - STOPPING
          - MOVING
          - UPGRADING
          - RESTORING
          - BACKUP_IN_PROGRESS
          - ROLLBACK_IN_PROGRESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        previousOggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        releaseType:
          description: 'The type of release.

            '
          enum:
          - MAJOR
          - BUNDLE
          - MINOR
          type: string
          x-obmcs-top-level-enum: '#/definitions/ReleaseType'
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the request was finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeOggVersionSupportedUntil:
          description: 'The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeReleased:
          description: 'The time the resource was released. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeSchedule:
          description: 'The time of upgrade schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeScheduleMax:
          description: 'Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeSnoozedUntil:
          description: 'The time the upgrade notifications are snoozed until. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - deploymentId
      - deploymentUpgradeType
      type: object
    DeploymentPeerCollection:
      description: 'A list of DeploymentPeers.

        '
      properties:
        items:
          description: 'An array of DeploymentPeers.

            '
          items:
            $ref: '#/components/schemas/DeploymentPeerSummary'
          type: array
      required:
      - items
      type: object
    DeploymentPeerSummary:
      description: 'The summary of the deployment Peer.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        lifecycleState:
          description: Possible lifecycle states for deployment peer.
          enum:
          - CREATING
          - ACTIVE
          - FAILED
          - UPDATING
          - DELETING
          - INACTIVE
          type: string
        peerRole:
          description: 'The type of the deployment role.

            '
          enum:
          - PRIMARY
          - STANDBY
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentRole'
        peerType:
          description: 'The type of the deployment peer.

            '
          enum:
          - LOCAL
          - REMOTE
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentPeerType'
        precheckStatus:
          description: Status of the DR precheck result.
          enum:
          - SUCCEEDED
          - IN_PROGRESS
          - FAILED
          - NEEDS_ATTENTION
          type: string
          x-obmcs-top-level-enum: '#/definitions/PrecheckStatus'
        region:
          description: 'The name of the region. e.g.: us-ashburn-1

            If the region is not provided, backend will default to the default region.

            '
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeLastPrecheckPerformed:
          description: 'The timestamp when pre-check started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

            '
          format: date-time
          type: string
        timeLastSynced:
          description: 'The time of the last data synchronization from the primary to the standby peer.

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeRoleChanged:
          description: 'The time of the last role change. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - deploymentId
      - region
      - availabilityDomain
      - faultDomain
      - displayName
      - peerType
      - peerRole
      - timeRoleChanged
      - timeCreated
      - timeUpdated
      - lifecycleState
      type: object
    RemoveResourceLockDetails:
      description: 'Used to remove a resource lock.

        Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    DeploymentVersionSummary:
      description: 'The summary data of a specific deployment version.

        '
      properties:
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        isSecurityFix:
          description: 'Indicates if OGG release contains security fix.

            '
          type: boolean
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        releaseType:
          description: 'The type of release.

            '
          enum:
          - MAJOR
          - BUNDLE
          - MINOR
          type: string
          x-obmcs-top-level-enum: '#/definitions/ReleaseType'
        timeReleased:
          description: 'The time the resource was released. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeSupportedUntil:
          description: 'The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - oggVersion
      - deploymentType
      type: object
    CreateDatabaseRegistrationDetails:
      description: 'The information about a new DatabaseRegistration.

        '
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionString:
          description: 'Connect descriptor or Easy Connect Naming method used to connect to a database.

            '
          maxLength: 2000
          minLength: 1
          type: string
        databaseId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        ipAddress:
          description: 'The private IP address in the customer''s VCN of the customer''s endpoint, typically a

            database.

            '
          maxLength: 46
          minLength: 0
          type: string
        keyId:
          description: "Refers to the customer's master key OCID. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 0
          type: string
        password:
          description: 'The password Oracle GoldenGate uses to connect the associated system of the given technology.

            It must conform to the specific security requirements including length, case sensitivity, and so on.

            Deprecated: This field is deprecated and replaced by "passwordSecretId".

            This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

            '
          format: password
          maxLength: 255
          minLength: 0
          type: string
        secretCompartmentId:
          description: "The OCID of the compartment where the GoldenGate Secret will be created. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 1
          type: string
        sessionMode:
          default: DIRECT
          description: 'The mode of the database connection session to be established by the data client.

            ''REDIRECT'' - for a RAC database, ''DIRECT'' - for a non-RAC database.

            Connection to a RAC database involves a redirection received from the SCAN listeners

            to the database node to connect to. By default the mode would be DIRECT.

            '
          enum:
          - DIRECT
          - REDIRECT
          type: string
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        username:
          description: 'The username Oracle GoldenGate uses to connect the associated system of the given technology.

            This username must already exist and be available by the system/application to be connected to

            and must conform to the case sensitivty requirments defined in it.

            '
          maxLength: 255
          minLength: 0
          type: string
        vaultId:
          description: "Refers to the customer's vault OCID. \nIf provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate\nto manage secrets contained within this vault.\n"
          maxLength: 255
          minLength: 0
          type: string
        wallet:
          description: 'The wallet contents Oracle GoldenGate uses to make connections to a database.

            This attribute is expected to be base64 encoded.

            Deprecated: This field is deprecated and replaced by "walletSecretId".

            This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

            '
          format: password
          maxLength: 51200
          minLength: 0
          type: string
      required:
      - compartmentId
      - displayName
      - fqdn
      - aliasName
      - username
      - password
      type: object
    StartPipelineDetails:
      description: 'Details with which to start a pipeline.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'Type of pipeline start. This option applies when starting a pipeline.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/StartPipelineType'
      required:
      - type
      type: object
    ConnectionAssignmentSummary:
      description: Summary of the Connection Assignment.
      properties:
        aliasName:
          description: 'Credential store alias.

            '
          maxLength: 30
          minLength: 1
          pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection assignment being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Possible lifecycle states for connection assignments.
          type: string
          x-obmcs-enumref: '#/definitions/ConnectionAssignment/lifecycleState'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - deploymentId
      - connectionId
      - connectionType
      - aliasName
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    CreateDeploymentBackupDetails:
      description: 'The information about a new DeploymentBackup.

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/AddResourceLockDetails'
          maxItems: 1
          type: array
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        objectName:
          description: Name of the object to be uploaded to object storage
          type: string
      required:
      - displayName
      - compartmentId
      - deploymentId
      - namespaceName
      - bucketName
      - objectName
      type: object
    ChangePipelineCompartmentDetails:
      description: 'The new compartment for a Pipeline.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    CopyDeploymentBackupDetails:
      description: 'The information about the copy for a Deployment Backup.

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
      required:
      - namespaceName
      - bucketName
      type: object
    UpgradeDeploymentDetails:
      description: The information about the Upgrade for a Deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment upgrade

            '
          enum:
          - CURRENT_RELEASE
          - SPECIFIC_RELEASE
          type: string
          x-obmcs-top-level-enum: '#/definitions/UpgradeDeploymentType'
      required:
      - type
      type: object
    RestoreDeploymentDetails:
      description: The information about the Restore for a Deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment restore.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/RestoreDeploymentType'
      required:
      - type
      type: object
    SwitchoverDeploymentPeerDetails:
      description: 'The information about switching to deployment peer.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        mode:
          default: SWITCHOVER
          description: 'Specifies the switchover mode. SWITCHOVER performs a planned role transition to the standby; FAILOVER performs a forced promotion when the primary is not available.

            '
          enum:
          - SWITCHOVER
          - FAILOVER
          type: string
      required:
      - availabilityDomain
      - faultDomain
      type: object
    StartDeploymentDetails:
      description: The information about the Start for a Deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment start

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/StartDeploymentType'
      required:
      - type
      type: object
    AddDeploymentLocalPeerDetails:
      description: 'The information about adding a deployment peer in list.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
      type: object
    UpdateConnectionDetails:
      description: 'The information to update a Connection.

        '
      discriminator:
        propertyName: connectionType
      properties:
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        doesUseSecretIds:
          default: false
          description: 'Indicates that sensitive attributes are provided via Secrets.


            Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID

            attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes. This change follows

            the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            When set to `true`, all sensitive information must be provided as OCI Vault secrets using the corresponding

            `*SecretId` attributes of the connection (for example, `passwordSecretId`). Plain-text sensitive attributes (for example, `password`) must not be used.

            This ensures that sensitive information remains stored and managed in the customer''s OCI Vault rather than by the GoldenGate service.


            When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, `password`) rather than in secret OCID attributes.

            In this mode, the sensitive information is stored by the GoldenGate service. If `vaultId` and `keyId` are not specified,

            the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.


            If `vaultId` and `keyId` are provided, the specified customer-managed key is used.

            '
          type: boolean
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        keyId:
          description: 'References the OCI Vault key in the OCI Vault identified by `vaultId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API.

            This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided,

            the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data.

            If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.

            '
          maxLength: 255
          minLength: 0
          type: string
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        routingMethod:
          description: "Controls the network traffic direction to the target:\nSHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.\nDEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.\nSHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. \n\nDeprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method.\nThis change follows the GoldenGate \"Plain Text Fields in Connections\" deprecation:\nhttps://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate\n"
          enum:
          - SHARED_SERVICE_ENDPOINT
          - SHARED_DEPLOYMENT_ENDPOINT
          - DEDICATED_ENDPOINT
          type: string
          x-default-description: 'null'
          x-obmcs-top-level-enum: '#/definitions/RoutingMethod'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        vaultId:
          description: 'References the OCI Vault that contains the customer-managed encryption key identified by `keyId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            This field is applicable only when `doesUseSecretIds` is set to `false`.

            If `vaultId` is provided, `keyId` must also be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
      type: object
    PausePipelineDetails:
      description: 'Details for a pipeline pause.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'Type of a pipeline pause. This option applies when pausing a pipeline.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/PausePipelineType'
      required:
      - type
      type: object
    ChangeDeploymentCompartmentDetails:
      description: 'The new compartment for a Deployment.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    LicenseModel:
      description: 'The Oracle license model that applies to a Deployment.

        '
      enum:
      - LICENSE_INCLUDED
      - BRING_YOUR_OWN_LICENSE
      type: string
    DatabaseRegistrationCollection:
      description: 'A list of DatabaseRegistrations.

        '
      properties:
        items:
          description: 'An array of DatabaseRegistration summaries.

            '
          items:
            $ref: '#/components/schemas/DatabaseRegistrationSummary'
          type: array
      required:
      - items
      type: object
    DeploymentCollection:
      description: 'A list of Deployments.

        '
      properties:
        items:
          description: 'An array of Deployment summaries.

            '
          items:
            $ref: '#/components/schemas/DeploymentSummary'
          type: array
      required:
      - items
      type: object
    CreateBackupScheduleDetails:
      description: 'Defines the backup schedule details for create operation.

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        frequencyBackupScheduled:
          description: 'The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.

            '
          enum:
          - DAILY
          - WEEKLY
          - MONTHLY
          type: string
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        timeBackupScheduled:
          description: 'The start timestamp for the deployment backup schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - timeBackupScheduled
      - frequencyBackupScheduled
      - bucketName
      - compartmentId
      - namespaceName
      - isMetadataOnly
      type: object
    DeploymentPlacementDetails:
      description: "Specifies a possible deployment placement. \nPlacement either explicitly specifies the availability and fault domain, \nor it is partial and lets Oracle to find an optimal placement.\n"
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
      type: object
    ChangeDatabaseRegistrationCompartmentDetails:
      description: 'The new compartment for a DatabaseRegistration.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    DeploymentWalletExistsDetails:
      description: The information to check if a wallet is present in the Deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment for wallet

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/WalletExistsDeploymentType'
      required:
      - type
      type: object
    DeploymentBackup:
      description: 'A backup of the current state of the GoldenGate deployment. Can be used to restore a deployment, or create a new deployment with that state as the starting deployment state.

        '
      properties:
        backupSourceType:
          description: 'Possible deployment backup source types.

            '
          enum:
          - MANUAL
          - AUTOMATIC
          - SCHEDULED
          type: string
        backupType:
          description: 'Possible Deployment backup types.

            '
          enum:
          - INCREMENTAL
          - FULL
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentBackupType'
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isAutomatic:
          description: 'True if this object is automatically created

            '
          type: boolean
          x-default-description: false
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment Backup.

            '
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          - CANCELING
          - CANCELED
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        objectName:
          description: Name of the object to be uploaded to object storage
          type: string
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        sizeInBytes:
          description: 'The size of the backup stored in object storage (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeBackupFinished:
          description: 'The time of the resource backup finish. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeOfBackup:
          description: 'The time of the resource backup. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
          x-default-description: 'null'
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - deploymentId
      - deploymentType
      - compartmentId
      - lifecycleState
      - oggVersion
      type: object
    CreateMaintenanceWindowDetails:
      description: 'Defines the maintenance window for create operation, when automatic actions can be performed.

        '
      properties:
        day:
          description: 'Days of the week.

            '
          enum:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          - SUNDAY
          type: string
          x-obmcs-top-level-enum: '#/definitions/Day'
        startHour:
          description: 'Start hour for maintenance period. Hour is in UTC.

            '
          maximum: 23
          minimum: 0
          type: integer
      required:
      - day
      - startHour
      type: object
    PipelineRunningProcessCollection:
      description: 'The complete replication process and its details.

        '
      properties:
        items:
          description: 'The list of replication processes and their details.

            '
          items:
            $ref: '#/components/schemas/PipelineRunningProcessSummary'
          type: array
      required:
      - items
      type: object
    ImportDeploymentWalletDetails:
      description: 'Metadata required to import wallet to deployment

        '
      properties:
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        masterEncryptionKeyId:
          description: "Refers to the customer's master key OCID. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 0
          type: string
        newWalletSecretId:
          description: "The OCID of the customer's GoldenGate Service Secret. \nIf provided, it references a key that customers will be required to ensure the policies are established \nto permit GoldenGate to use this Secret.\n"
          maxLength: 255
          minLength: 1
          type: string
        vaultId:
          description: "Refers to the customer's vault OCID. \nIf provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate\nto manage secrets contained within this vault.\n"
          maxLength: 255
          minLength: 0
          type: string
        walletBackupSecretCompartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment, where the secret will be created in.

            '
          maxLength: 255
          minLength: 0
          type: string
        walletBackupSecretName:
          description: Name of the secret with which secret is shown in vault
          type: string
      required:
      - vaultId
      - newWalletSecretId
      type: object
    GenerateLibraryUrlDetails:
      description: The information about generating the library URL.
      discriminator:
        propertyName: libraryType
      properties:
        libraryType:
          description: 'The type of the library URL generation.

            '
          enum:
          - LOG_READER_COMPONENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/LibraryType'
      required:
      - libraryType
      type: object
    UpgradeDeploymentUpgradeDetails:
      description: The information about the upgrade for a deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment start.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/UpgradeDeploymentUpgradeType'
      required:
      - type
      type: object
    DeploymentEnvironmentCollection:
      description: 'The list of DeploymentEnvironmentDescriptor objects.

        '
      properties:
        items:
          description: 'Array of DeploymentEnvironmentSummary objects.

            '
          items:
            $ref: '#/components/schemas/DeploymentEnvironmentSummary'
          type: array
      required:
      - items
      type: object
    CreateCertificateDetails:
      description: The information about a new Certificates.
      properties:
        certificateContent:
          description: 'The base64 encoded content of the PEM file containing the SSL certificate.

            '
          maxLength: 65536
          minLength: 0
          type: string
        key:
          description: "The identifier key (unique name in the scope of the deployment) of the certificate being referenced. \nIt must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.\n"
          maxLength: 32
          minLength: 1
          type: string
      required:
      - key
      - certificateContent
      type: object
    DeploymentWalletsOperationCollection:
      description: 'A list of deployment wallets operations.

        '
      properties:
        items:
          description: 'An array of DeploymentWallets operations.

            '
          items:
            $ref: '#/components/schemas/DeploymentWalletsOperationSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestLogEntry:
      description: 'A log message from the execution of a work request.

        '
      properties:
        message:
          description: 'Human-readable log message.

            '
          type: string
        timestamp:
          description: 'The time the log message was written.  The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - message
      - timestamp
    PipelineInitializationStep:
      description: 'The step and its progress based on the recipe type.

        '
      properties:
        messages:
          description: 'The list of messages for each step while running.

            '
          items:
            $ref: '#/components/schemas/StepMessage'
          type: array
        name:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        percentComplete:
          description: 'Shows the percentage complete of each recipe step during pipeline initialization.

            '
          maximum: 100
          minimum: 0
          type: integer
        status:
          description: 'Status of the steps in a recipe. This option applies during pipeline initialization.

            '
          enum:
          - PENDING
          - IN_PROGRESS
          - COMPLETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/StepStatusType'
        timeFinished:
          description: 'The date and time the request was finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - name
      - status
      - percentComplete
      - timeStarted
      - timeFinished
      type: object
    TechnologyType:
      description: 'The technology type.

        '
      enum:
      - GOLDENGATE
      - GENERIC
      - OCI_AUTONOMOUS_DATABASE
      - OCI_AUTONOMOUS_JSON_DATABASE
      - OCI_CACHE_WITH_REDIS
      - OCI_MYSQL
      - OCI_OBJECT_STORAGE
      - OCI_POSTGRESQL
      - OCI_STREAMING
      - OCI_STREAMING_WITH_APACHE_KAFKA
      - ORACLE_DATABASE
      - ORACLE_EXADATA
      - ORACLE_EXADATA_EXASCALE
      - ORACLE_EXADATA_DATABASE_AT_AZURE
      - ORACLE_EXADATA_EXASCALE_AT_AZURE
      - ORACLE_AUTONOMOUS_DATABASE_AT_AZURE
      - ORACLE_JSON_COLLECTION
      - ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD
      - ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_EXADATA_DATABASE_AT_AWS
      - ORACLE_AUTONOMOUS_DATABASE_AT_AWS
      - ORACLE_AI_DATA_PLATFORM
      - ORACLE_NOSQL
      - ORACLE_REST_DATA_SERVICES
      - ORACLE_WEBLOGIC_JMS
      - AMAZON_RDS_ORACLE
      - AMAZON_RDS_SQLSERVER
      - AMAZON_S3
      - AMAZON_AURORA_MYSQL
      - AMAZON_AURORA_POSTGRESQL
      - AMAZON_DOCUMENT_DB
      - AMAZON_KINESIS
      - AMAZON_REDSHIFT
      - AMAZON_RDS_MARIADB
      - AMAZON_RDS_MYSQL
      - AMAZON_RDS_POSTGRESQL
      - APACHE_ICEBERG
      - APACHE_KAFKA
      - AZURE_COSMOS_DB_FOR_MONGODB
      - AZURE_COSMOS_DB_FOR_POSTGRESQL
      - AZURE_DATA_LAKE_STORAGE
      - AZURE_EVENT_HUBS
      - AZURE_MYSQL
      - AZURE_POSTGRESQL
      - AZURE_SQLSERVER_MANAGED_INSTANCE
      - AZURE_SQLSERVER_NON_MANAGED_INSTANCE
      - AZURE_SYNAPSE_ANALYTICS
      - CONFLUENT_KAFKA
      - CONFLUENT_SCHEMA_REGISTRY
      - DATABRICKS
      - DB2_I
      - DB2_ZOS
      - ELASTICSEARCH
      - EDB_POSTGRES_ADVANCED_SERVER
      - GOOGLE_ALLOY_DB_FOR_POSTGRESQL
      - GOOGLE_BIGQUERY
      - GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA
      - GOOGLE_CLOUD_STORAGE
      - GOOGLE_CLOUD_SQL_MYSQL
      - GOOGLE_CLOUD_SQL_POSTGRESQL
      - GOOGLE_CLOUD_SQL_SQLSERVER
      - GOOGLE_PUBSUB
      - HDFS
      - MARIADB
      - MICROSOFT_SQLSERVER
      - MICROSOFT_FABRIC_EVENTSTREAM
      - MICROSOFT_FABRIC_LAKEHOUSE
      - MICROSOFT_FABRIC_MIRROR
      - MONGODB
      - MYSQL_SERVER
      - MYSQL_HEATWAVE_ON_AZURE
      - MYSQL_HEATWAVE_ON_AWS
      - POSTGRESQL_SERVER
      - REDIS
      - SINGLESTOREDB
      - SINGLESTOREDB_CLOUD
      - SNOWFLAKE
      - YUGABYTE_DB
      - AI_MODEL
      type: string
    WorkRequest:
      description: 'The API operations that create and configure GoldenGate resources do not take effect

        immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the

        request. Work requests provide visibility into the status of these in-progress, long-running

        asynchronous workflows.

        '
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped

            to the same compartment as the resource the work request affects. If the work request

            affects multiple resources, and those resources are not in the same compartment, it is up

            to the service team to pick the primary resource whose compartment should be used.

            '
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: 'The id of the work request.

            '
          maxLength: 255
          minLength: 1
          type: string
        operationType:
          description: 'The work request''s operation type.

            '
          enum:
          - GOLDENGATE_DATABASE_REGISTRATION_CREATE
          - GOLDENGATE_DATABASE_REGISTRATION_UPDATE
          - GOLDENGATE_DATABASE_REGISTRATION_DELETE
          - GOLDENGATE_DATABASE_REGISTRATION_MOVE
          - GOLDENGATE_DEPLOYMENT_CREATE
          - GOLDENGATE_DEPLOYMENT_UPDATE
          - GOLDENGATE_DEPLOYMENT_DELETE
          - GOLDENGATE_DEPLOYMENT_MOVE
          - GOLDENGATE_DEPLOYMENT_RESTORE
          - GOLDENGATE_DEPLOYMENT_START
          - GOLDENGATE_DEPLOYMENT_STOP
          - GOLDENGATE_DEPLOYMENT_UPGRADE
          - GOLDENGATE_DEPLOYMENT_BACKUP_CREATE
          - GOLDENGATE_DEPLOYMENT_BACKUP_DELETE
          - GOLDENGATE_DEPLOYMENT_BACKUP_CANCEL
          - GOLDENGATE_DEPLOYMENT_BACKUP_COPY
          - GOLDENGATE_CONNECTION_CREATE
          - GOLDENGATE_CONNECTION_UPDATE
          - GOLDENGATE_CONNECTION_DELETE
          - GOLDENGATE_CONNECTION_MOVE
          - GOLDENGATE_CONNECTION_REFRESH
          - GOLDENGATE_CONNECTION_MIGRATE_SECRETS
          - GOLDENGATE_CONNECTION_ASSIGNMENT_CREATE
          - GOLDENGATE_CONNECTION_ASSIGNMENT_DELETE
          - GOLDENGATE_DEPLOYMENT_DIAGNOSTIC_COLLECT
          - GOLDENGATE_DEPLOYMENT_WALLET_EXPORT
          - GOLDENGATE_DEPLOYMENT_WALLET_IMPORT
          - GOLDENGATE_DEPLOYMENT_UPGRADE_UPGRADE
          - GOLDENGATE_DEPLOYMENT_UPGRADE_ROLLBACK
          - GOLDENGATE_DEPLOYMENT_UPGRADE_SNOOZE
          - GOLDENGATE_DEPLOYMENT_CERTIFICATE_CREATE
          - GOLDENGATE_DEPLOYMENT_CERTIFICATE_DELETE
          - GOLDENGATE_PIPELINE_CREATE
          - GOLDENGATE_PIPELINE_START
          - GOLDENGATE_PIPELINE_STOP
          - GOLDENGATE_PIPELINE_UPDATE
          - GOLDENGATE_PIPELINE_DELETE
          - GOLDENGATE_PIPELINE_MOVE
          - GOLDENGATE_PIPELINE_DIAGNOSTICS_COLLECT
          - GOLDENGATE_SWITCHOVER_DEPLOYMENT_PEER
          - GOLDENGATE_PIPELINE_PAUSE
          - GOLDENGATE_PIPELINE_CLONE
          - GOLDENGATE_DEPLOYMENT_DISASTER_RECOVERY_PRECHECK
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: 'Percentage of the request completed.

            '
          format: float
          maximum: 100
          minimum: 0
          type: number
        resources:
          description: 'The resources affected by this work request.

            '
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: 'Status of current work request.

            '
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the request was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the request was finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    BackupSchedule:
      description: 'Defines the schedule of the deployment backup.

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        frequencyBackupScheduled:
          description: 'The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.

            '
          enum:
          - DAILY
          - WEEKLY
          - MONTHLY
          type: string
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        timeBackupScheduled:
          description: 'The start timestamp for the deployment backup schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - timeBackupScheduled
      - frequencyBackupScheduled
      - bucketName
      - compartmentId
      - namespaceName
      - isMetadataOnly
      type: object
    CreateConnectionAssignmentDetails:
      description: 'The information about a new Connection Assignment.

        '
      properties:
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - connectionId
      - deploymentId
      type: object
    ChangeDeploymentSubscriptionDetails:
      allOf:
      - $ref: '#/components/schemas/ChangeSubscriptionDetails'
      description: 'The configuration details for associating the GoldenGate deployment resource with a different subscription.

        '
    TargetPipelineConnectionDetails:
      description: 'The target connection details for creating a pipeline.

        '
      properties:
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - connectionId
      type: object
    TrailFileSummary:
      description: 'Summary of the TrailFiles.

        '
      properties:
        consumers:
          description: 'array of consumer process names

            '
          items:
            maxLength: 32
            minLength: 0
            type: string
          type: array
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        maxSequenceNumber:
          description: 'Maximum sequence number

            '
          maxLength: 12
          minLength: 0
          type: string
        minSequenceNumber:
          description: 'Minimum sequence number

            '
          maxLength: 12
          minLength: 0
          type: string
        numberOfSequences:
          description: 'Number of sequences for a specific trail file

            '
          minimum: 0
          type: integer
        producer:
          description: 'Producer Process Name if any.

            '
          maxLength: 32
          minLength: 0
          type: string
        sizeInBytes:
          description: 'The size of the backup stored in object storage (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        timeLastUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        trailFileId:
          description: 'The TrailFile Id.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - trailFileId
      type: object
    Certificate:
      description: Certificate data.
      properties:
        authorityKeyId:
          description: 'The Certificate authority key id.

            '
          maxLength: 255
          minLength: 0
          type: string
        certificateContent:
          description: 'The base64 encoded content of the PEM file containing the SSL certificate.

            '
          maxLength: 65536
          minLength: 0
          type: string
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isCa:
          description: 'Indicates if the certificate is ca.

            '
          type: boolean
        isSelfSigned:
          description: 'Indicates if the certificate is self signed.

            '
          type: boolean
        issuer:
          description: 'The Certificate issuer.

            '
          maxLength: 255
          minLength: 0
          type: string
        key:
          description: "The identifier key (unique name in the scope of the deployment) of the certificate being referenced. \nIt must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.\n"
          maxLength: 32
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible certificate lifecycle states.

            '
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState'
        md5Hash:
          description: 'The Certificate md5Hash.

            '
          maxLength: 255
          minLength: 0
          type: string
        publicKey:
          description: 'The Certificate public key.

            '
          maxLength: 51200
          minLength: 0
          type: string
        publicKeyAlgorithm:
          description: 'The Certificate public key algorithm.

            '
          maxLength: 255
          minLength: 0
          type: string
        publicKeySize:
          description: 'The Certificate public key size.

            '
          format: int64
          type: integer
        serial:
          description: 'The Certificate serial.

            '
          maxLength: 255
          minLength: 0
          type: string
        sha1Hash:
          description: 'The Certificate sha1 hash.

            '
          maxLength: 255
          minLength: 0
          type: string
        subject:
          description: 'The Certificate subject.

            '
          example: 'C=AA,O=AAAA,OU=AAAA,CN=AAAA

            '
          maxLength: 255
          minLength: 0
          type: string
        subjectKeyId:
          description: 'The Certificate subject key id.

            '
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeValidFrom:
          description: 'The time the certificate is valid from. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeValidTo:
          description: 'The time the certificate is valid to. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        version:
          description: 'The Certificate version.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - key
      - deploymentId
      - certificateContent
      - issuer
      - isSelfSigned
      - md5Hash
      - publicKey
      - publicKeyAlgorithm
      - publicKeySize
      - serial
      - subject
      - timeValidFrom
      - timeValidTo
      - version
      - sha1Hash
      - authorityKeyId
      - isCa
      - subjectKeyId
      - lifecycleState
      - timeCreated
      type: object
    DeploymentUpgradeCollection:
      description: 'A list of Deployment Upgrades.

        '
      properties:
        items:
          description: 'An array of Deployment Upgrade summaries.

            '
          items:
            $ref: '#/components/schemas/DeploymentUpgradeSummary'
          type: array
      required:
      - items
      type: object
    PipelineCollection:
      description: 'List of pipeline summary objects.

        '
      properties:
        items:
          description: 'An array of Pipeline summaries.

            '
          items:
            $ref: '#/components/schemas/PipelineSummary'
          type: array
          x-default-description: 'null'
      required:
      - items
      type: object
    Deployment:
      description: 'A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        backupSchedule:
          $ref: '#/components/schemas/BackupSchedule'
        byolCpuCoreCountLimit:
          description: 'The maximum number of CPUs allowed with a ''Bring Your Own License'' (BYOL) license type.

            Any CPU usage above this limit is considered as License Included and billed.

            '
          minimum: 1
          type: integer
        category:
          description: 'The deployment category defines the broad separation of the deployment type into four categories.

            Currently the separation is ''DATA_REPLICATION'', ''STREAM_ANALYTICS'', ''DATA_TRANSFORMS'' and ''DATA_VERIFICATION''.

            '
          enum:
          - DATA_REPLICATION
          - STREAM_ANALYTICS
          - DATA_TRANSFORMS
          - DATA_VERIFICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentCategory'
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentBackupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentDiagnosticData:
          $ref: '#/components/schemas/DeploymentDiagnosticData'
        deploymentRole:
          description: 'The type of the deployment role.

            '
          enum:
          - PRIMARY
          - STANDBY
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentRole'
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        deploymentUrl:
          description: 'The URL of a resource.

            '
          minLength: 0
          type: string
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        disasterRecoveryStatus:
          description: 'Indicates if disaster recovery is enabled for a deployment.

            If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DisasterRecoveryStatus'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        environmentType:
          description: 'Specifies whether the deployment is used in a production or development/testing environment.

            '
          enum:
          - PRODUCTION
          - DEVELOPMENT_OR_TESTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        ingressIps:
          description: "List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. \nCustomers may optionally set up ingress security rules to restrict traffic from these IP addresses.\n"
          items:
            $ref: '#/components/schemas/IngressIpDetails'
          type: array
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        isByolCpuCoreCountLimitEnabled:
          default: false
          description: 'Flag to allow to configure the ''Bring Your Own License'' (BYOL) license type CPU limit.

            If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

            '
          type: boolean
        isHealthy:
          description: 'True if all of the aggregate resources are working correctly.

            '
          type: boolean
        isLatestVersion:
          description: 'Indicates if the resource is the the latest available version.

            '
          type: boolean
        isPublic:
          description: 'True if this object is publicly available.

            '
          type: boolean
          x-default-description: false
        isStorageUtilizationLimitExceeded:
          description: 'Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.

            Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit.  Exceeding the limit may be an indication of a misconfiguration of the deployment''s GoldenGate service.

            '
          type: boolean
          x-default-description: false
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - DELETING
          - DELETED
          - FAILED
          - NEEDS_ATTENTION
          type: string
        lifecycleSubState:
          description: 'Possible GGS lifecycle sub-states.

            '
          enum:
          - RECOVERING
          - STARTING
          - STOPPING
          - MOVING
          - UPGRADING
          - RESTORING
          - BACKUP_IN_PROGRESS
          - ROLLBACK_IN_PROGRESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
        loadBalancerId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer''s subnet.

            The loadbalancer of the public deployment created in the customer subnet.

            '
          maxLength: 255
          minLength: 1
          type: string
        loadBalancerSubnetId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.\n\nRules:\n- Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.\n- Update:\n  - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).\n  - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.\n\nValidation:\n- Must reference a public subnet.\n- Must be a regional subnet.\n- Must be in the same VCN as subnetId.\n"
          maxLength: 255
          minLength: 0
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        maintenanceConfiguration:
          $ref: '#/components/schemas/MaintenanceConfiguration'
        maintenanceWindow:
          $ref: '#/components/schemas/MaintenanceWindow'
        nextMaintenanceActionType:
          description: 'Type of the next maintenance.

            '
          enum:
          - UPGRADE
          type: string
          x-obmcs-top-level-enum: '#/definitions/MaintenanceActionType'
        nextMaintenanceDescription:
          description: 'Description of the next maintenance.

            '
          minLength: 1
          type: string
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        oggData:
          $ref: '#/components/schemas/OggDeployment'
        placements:
          description: 'An array of local peers of deployment

            '
          items:
            $ref: '#/components/schemas/DeploymentPlacementInfo'
          type: array
        privateIpAddress:
          description: 'The private IP address in the customer''s VCN representing the access point for the

            associated endpoint service in the GoldenGate service VCN.

            '
          maxLength: 46
          minLength: 1
          type: string
        publicIpAddress:
          description: 'The public IP address representing the access point for the Deployment.

            '
          maxLength: 46
          minLength: 1
          type: string
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        sourceDeploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        storageUtilizationInBytes:
          description: 'The amount of storage being utilized (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the deployment''s private endpoint.

            The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,

            after which the private subnet will be enforced.

            '
          maxLength: 255
          minLength: 1
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeLastBackupScheduled:
          description: 'The timestamp of last deployment backup scheduled. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

            '
          format: date-time
          type: string
        timeNextBackupScheduled:
          description: 'The timestamp of next deployment backup scheduled. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

            '
          format: date-time
          type: string
        timeOfNextMaintenance:
          description: 'The time of next maintenance schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeOggVersionSupportedUntil:
          description: 'The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeRoleChanged:
          description: 'The time of the last role change. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - cpuCoreCount
      - licenseModel
      - isAutoScalingEnabled
      - deploymentType
      - category
      type: object
    DeploymentUpgrade:
      description: 'A container for your OCI GoldenGate Upgrade information.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentUpgradeType:
          description: 'The type of the deployment upgrade: MANUAL or AUTOMATIC

            '
          enum:
          - MANUAL
          - AUTOMATIC
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentUpgradeType'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment upgrade being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isCancelAllowed:
          description: "Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service, \notherwise only reschedule allowed.\n"
          type: boolean
        isRescheduleAllowed:
          description: 'Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.

            '
          type: boolean
        isRollbackAllowed:
          description: 'Indicates if rollback is allowed. In practice only the last upgrade can be rolled back.

            - Manual upgrade is allowed to rollback only until the old version isn''t deprecated yet.

            - Automatic upgrade by default is not allowed, unless a serious issue does not justify.

            '
          type: boolean
        isSecurityFix:
          description: 'Indicates if OGG release contains security fix.

            '
          type: boolean
        isSnoozed:
          description: 'Indicates if upgrade notifications are snoozed or not.

            '
          type: boolean
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment Upgrade.

            '
          enum:
          - WAITING
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELED
          type: string
        lifecycleSubState:
          description: 'Possible GGS lifecycle sub-states.

            '
          enum:
          - RECOVERING
          - STARTING
          - STOPPING
          - MOVING
          - UPGRADING
          - RESTORING
          - BACKUP_IN_PROGRESS
          - ROLLBACK_IN_PROGRESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        previousOggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        releaseType:
          description: 'The type of release.

            '
          enum:
          - MAJOR
          - BUNDLE
          - MINOR
          type: string
          x-obmcs-top-level-enum: '#/definitions/ReleaseType'
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the request was finished. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeOggVersionSupportedUntil:
          description: 'The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeReleased:
          description: 'The time the resource was released. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeSchedule:
          description: 'The time of upgrade schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeScheduleMax:
          description: 'Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeSnoozedUntil:
          description: 'The time the upgrade notifications are snoozed until. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - deploymentId
      - deploymentUpgradeType
      type: object
    TestConnectionAssignmentDetails:
      description: The information about testing the assigned connection.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of the test of the assigned connection.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/TestConnectionAssignmentType'
      required:
      - type
      type: object
      x-example: "{\n  \"type\": \"DEFAULT\"\n}\n"
    UpdateMaintenanceConfigurationDetails:
      description: 'Defines the maintenance configuration for update operation.

        '
      properties:
        bundleReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.

            This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        interimReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.

            '
          minimum: 0
          type: integer
        isInterimReleaseAutoUpgradeEnabled:
          description: "By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, \nyou have to specify interimReleaseUpgradePeriodInDays too.\n"
          type: boolean
        majorReleaseUpgradePeriodInDays:
          description: 'Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
        securityPatchUpgradePeriodInDays:
          description: 'Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.

            Not passing this field during create will equate to using the service default.

            '
          minimum: 0
          type: integer
      type: object
    RollbackDeploymentUpgradeDetails:
      description: The information about the rollback of an upgrade.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deploymentUpgrade rollback.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/RollbackDeploymentUpgradeType'
      required:
      - type
      type: object
    DeploymentTypeCollection:
      description: 'The list of DeploymentTypeDescriptor objects.

        '
      properties:
        items:
          description: 'Array of DeploymentTypeSummary

            '
          items:
            $ref: '#/components/schemas/DeploymentTypeSummary'
          type: array
      required:
      - items
      type: object
    DeploymentDiagnosticData:
      description: 'Information regarding the deployment diagnostic collection

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        diagnosticState:
          description: 'The state of the deployment diagnostic collection.

            '
          enum:
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentDiagnosticState'
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        objectName:
          description: Name of the diagnostic collected and uploaded to object storage
          type: string
        timeDiagnosticEnd:
          description: The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
          format: date-time
          type: string
        timeDiagnosticStart:
          description: The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
          format: date-time
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
      - diagnosticState
      type: object
    WorkRequestResource:
      description: 'A resource created or operated on by a work request.

        '
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.  When

            you create, update, or delete a resource, it remains in the IN_PROGRESS state until work

            is complete for that resource.  It then transitions to CREATED, UPDATED, or DELETED,

            respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: 'The resource type the work request affects.

            '
          type: string
        entityUri:
          description: 'The URI path that you perform a GET on to access the resource metadata.

            '
          type: string
        identifier:
          description: 'The identifier of the resource the work request affects.

            '
          type: string
      required:
      - actionType
      - entityType
      - identifier
    StepMessage:
      description: 'Contents of a step message.

        '
      properties:
        code:
          description: 'The code returned when GoldenGate reports an error while running a step during pipeline initialization.

            https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2

            '
          type: string
        message:
          description: 'The status message of the steps in a recipe during pipeline initialization.

            https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

            '
          type: string
        severity:
          description: 'The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization.

            https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

            '
          enum:
          - INFO
          - ERROR
          - WARNING
          type: string
          x-obmcs-top-level-enum: '#/definitions/SeverityType'
        timestamp:
          description: 'Date and time of a message issued by steps in a recipe during pipeline initialization.

            The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - message
      - code
      - timestamp
      - severity
      type: object
    DeploymentSummary:
      description: 'Summary of the Deployment.

        '
      properties:
        byolCpuCoreCountLimit:
          description: 'The maximum number of CPUs allowed with a ''Bring Your Own License'' (BYOL) license type.

            Any CPU usage above this limit is considered as License Included and billed.

            '
          minimum: 1
          type: integer
        category:
          description: 'The deployment category defines the broad separation of the deployment type into four categories.

            Currently the separation is ''DATA_REPLICATION'', ''STREAM_ANALYTICS'', ''DATA_TRANSFORMS'' and ''DATA_VERIFICATION''.

            '
          enum:
          - DATA_REPLICATION
          - STREAM_ANALYTICS
          - DATA_TRANSFORMS
          - DATA_VERIFICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentCategory'
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentRole:
          description: 'The type of the deployment role.

            '
          enum:
          - PRIMARY
          - STANDBY
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentRole'
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        deploymentUrl:
          description: 'The URL of a resource.

            '
          minLength: 0
          type: string
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        disasterRecoveryStatus:
          description: 'Indicates if disaster recovery is enabled for a deployment.

            If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

            '
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/DisasterRecoveryStatus'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        environmentType:
          description: 'Specifies whether the deployment is used in a production or development/testing environment.

            '
          enum:
          - PRODUCTION
          - DEVELOPMENT_OR_TESTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        isByolCpuCoreCountLimitEnabled:
          default: false
          description: 'Flag to allow to configure the ''Bring Your Own License'' (BYOL) license type CPU limit.

            If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

            '
          type: boolean
        isLatestVersion:
          description: 'Indicates if the resource is the the latest available version.

            '
          type: boolean
        isPublic:
          description: 'True if this object is publicly available.

            '
          type: boolean
          x-default-description: false
        isStorageUtilizationLimitExceeded:
          description: 'Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.

            Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit.  Exceeding the limit may be an indication of a misconfiguration of the deployment''s GoldenGate service.

            '
          type: boolean
          x-default-description: false
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment.

            '
          type: string
          x-obmcs-enumref: '#/definitions/Deployment/lifecycleState'
        lifecycleSubState:
          description: 'Possible GGS lifecycle sub-states.

            '
          enum:
          - RECOVERING
          - STARTING
          - STOPPING
          - MOVING
          - UPGRADING
          - RESTORING
          - BACKUP_IN_PROGRESS
          - ROLLBACK_IN_PROGRESS
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
        loadBalancerId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer''s subnet.

            The loadbalancer of the public deployment created in the customer subnet.

            '
          maxLength: 255
          minLength: 1
          type: string
        loadBalancerSubnetId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.\n\nRules:\n- Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.\n- Update:\n  - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).\n  - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.\n\nValidation:\n- Must reference a public subnet.\n- Must be a regional subnet.\n- Must be in the same VCN as subnetId.\n"
          maxLength: 255
          minLength: 0
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        privateIpAddress:
          description: 'The private IP address in the customer''s VCN representing the access point for the

            associated endpoint service in the GoldenGate service VCN.

            '
          maxLength: 46
          minLength: 1
          type: string
        publicIpAddress:
          description: 'The public IP address representing the access point for the Deployment.

            '
          maxLength: 46
          minLength: 1
          type: string
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        storageUtilizationInBytes:
          description: 'The amount of storage being utilized (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the deployment''s private endpoint.

            The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,

            after which the private subnet will be enforced.

            '
          maxLength: 255
          minLength: 1
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - licenseModel
      - deploymentType
      - category
      type: object
    UpdateGroupToRolesMappingDetails:
      description: 'Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments.

        For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used.

        User belonging to each group can only perform the actions according to the role the respective group is mapped to.

        '
      properties:
        administratorGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup.

            It grants full access to the user, including the ability to alter general, non-security related operational parameters

            and profiles of the server.

            '
          maxLength: 255
          minLength: 0
          type: string
        operatorGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup.

            It allows users to perform only operational actions, like starting and stopping resources.

            Operators cannot alter the operational parameters or profiles of the MA server.

            '
          maxLength: 255
          minLength: 0
          type: string
        securityGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup.

            It grants administration of security related objects and invoke security related service requests. This role has full privileges.

            '
          maxLength: 255
          minLength: 1
          type: string
        userGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup.

            It allows information-only service requests, which do not alter or affect the operation of either the MA.

            Examples of query and read-only information include performance metric information and resource status and monitoring information

            '
          maxLength: 255
          minLength: 0
          type: string
      type: object
    CancelSnoozeDeploymentUpgradeDetails:
      description: The information about snooze canceling.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deploymentUpgrade cancel snooze.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/CancelSnoozeDeploymentUpgradeType'
      required:
      - type
      type: object
    PipelineDiagnosticData:
      description: 'Information regarding the pipeline diagnostic collection

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        diagnosticState:
          description: 'The state of the pipeline diagnostics collection.

            '
          enum:
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/PipelineDiagnosticState'
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        objectName:
          description: Name of the diagnostic collected and uploaded to object storage
          type: string
        timeLastCollected:
          description: "The date and time the diagnostic data was last collected for the pipeline. The format is defined by \n[RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.\n"
          format: date-time
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
      - diagnosticState
      type: object
    GroupToRolesMappingDetails:
      description: 'Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments.

        For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used.

        User belonging to each group can only perform the actions according to the role the respective group is mapped to.

        '
      properties:
        administratorGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup.

            It grants full access to the user, including the ability to alter general, non-security related operational parameters

            and profiles of the server.

            '
          maxLength: 255
          minLength: 0
          type: string
        operatorGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup.

            It allows users to perform only operational actions, like starting and stopping resources.

            Operators cannot alter the operational parameters or profiles of the MA server.

            '
          maxLength: 255
          minLength: 0
          type: string
        securityGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup.

            It grants administration of security related objects and invoke security related service requests. This role has full privileges.

            '
          maxLength: 255
          minLength: 1
          type: string
        userGroupId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup.

            It allows information-only service requests, which do not alter or affect the operation of either the MA.

            Examples of query and read-only information include performance metric information and resource status and monitoring information

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - securityGroupId
      type: object
    PipelineInitializationSteps:
      description: 'The steps and their progress, based on the recipe type.

        '
      properties:
        items:
          description: 'The sequence of pipeline steps based on the recipe type.

            '
          items:
            $ref: '#/components/schemas/PipelineInitializationStep'
          type: array
      required:
      - items
      type: object
    UpdateMaintenanceWindowDetails:
      description: 'Defines the maintenance window for update operation, when automatic actions can be performed.

        '
      properties:
        day:
          description: 'Days of the week.

            '
          enum:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          - SUNDAY
          type: string
          x-obmcs-top-level-enum: '#/definitions/Day'
        startHour:
          description: 'Start hour for maintenance period. Hour is in UTC.

            '
          maximum: 23
          minimum: 0
          type: integer
      required:
      - day
      - startHour
      type: object
    WorkRequestError:
      description: 'An error encountered while executing a work request.

        '
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: 'A human-readable description of the issue encountered.

            '
          type: string
        timestamp:
          description: 'The time the error occured.  The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    RescheduleDeploymentUpgradeDetails:
      description: The information about canceling.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deploymentUpgrade reschedule.

            '
          enum:
          - RESCHEDULE_TO_DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/RescheduleDeploymentUpgradeType'
      required:
      - type
      type: object
    ExportDeploymentWalletDetails:
      description: 'Metadata required to export wallet from deployment

        '
      properties:
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        masterEncryptionKeyId:
          description: "Refers to the customer's master key OCID. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
          maxLength: 255
          minLength: 0
          type: string
        secretCompartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment, where the secret will be created in.

            '
          maxLength: 255
          minLength: 0
          type: string
        secretName:
          description: Name of the secret with which secret is shown in vault
          type: string
        vaultId:
          description: "Refers to the customer's vault OCID. \nIf provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate\nto manage secrets contained within this vault.\n"
          maxLength: 255
          minLength: 0
          type: string
      required:
      - vaultId
      - masterEncryptionKeyId
      - secretName
      type: object
    GenerateDisasterRecoveryPrecheckReportDetails:
      description: 'Metadata required to submit to generate a DR precheck report.

        '
      properties:
        availabilityDomain:
          description: The availability domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
        faultDomain:
          description: The fault domain of a placement.
          maxLength: 255
          minLength: 0
          type: string
      required:
      - availabilityDomain
      - faultDomain
      type: object
    ChangeDeploymentBackupCompartmentDetails:
      description: 'The new compartment for a DeploymentBackup.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    DeploymentWalletExistsResponseDetails:
      description: 'Indicates whether the wallet exists in the deployment container

        '
      properties:
        isOggWalletExists:
          description: Indicates if the wallet is present in the deployment container
          type: boolean
      required:
      - isOggWalletExists
      type: object
    UpdateDeploymentDetails:
      description: 'The information to use to update a Deployment.

        '
      properties:
        backupSchedule:
          $ref: '#/components/schemas/UpdateBackupScheduleDetails'
        byolCpuCoreCountLimit:
          description: 'The maximum number of CPUs allowed with a ''Bring Your Own License'' (BYOL) license type.

            Any CPU usage above this limit is considered as License Included and billed.

            '
          minimum: 1
          type: integer
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        environmentType:
          description: 'Specifies whether the deployment is used in a production or development/testing environment.

            '
          enum:
          - PRODUCTION
          - DEVELOPMENT_OR_TESTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
        fqdn:
          description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        isByolCpuCoreCountLimitEnabled:
          default: false
          description: 'Flag to allow to configure the ''Bring Your Own License'' (BYOL) license type CPU limit.

            If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

            '
          type: boolean
        isPublic:
          description: 'True if this object is publicly available.

            '
          type: boolean
          x-default-description: false
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        loadBalancerSubnetId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.\n\nRules:\n- Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.\n- Update:\n  - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).\n  - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.\n\nValidation:\n- Must reference a public subnet.\n- Must be a regional subnet.\n- Must be in the same VCN as subnetId.\n"
          maxLength: 255
          minLength: 0
          type: string
        maintenanceConfiguration:
          $ref: '#/components/schemas/UpdateMaintenanceConfigurationDetails'
        maintenanceWindow:
          $ref: '#/components/schemas/UpdateMaintenanceWindowDetails'
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        oggData:
          $ref: '#/components/schemas/UpdateOggDeploymentDetails'
        placements:
          description: 'An array of local peers of deployment

            '
          items:
            $ref: '#/components/schemas/DeploymentPlacementDetails'
          type: array
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the deployment''s private endpoint.

            The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,

            after which the private subnet will be enforced.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    AiProviderCollection:
      description: 'Collection of AI providers supported by GoldenGate.

        '
      properties:
        items:
          description: 'An array of AI providers.

            '
          items:
            $ref: '#/components/schemas/AiProviderSummary'
          maxItems: 100
          type: array
      required:
      - items
      type: object
    PipelineRunningProcessSummary:
      description: 'Each replication process and their summary details.

        '
      properties:
        lastRecordLagInSeconds:
          description: 'The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes.

            '
          format: float
          type: number
        name:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        processType:
          description: 'The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes.

            '
          enum:
          - EXTRACT
          - REPLICAT
          type: string
          x-obmcs-top-level-enum: '#/definitions/ProcessType'
        status:
          description: 'The status of the Extract or Replicat process. This option applies when retrieving running processes.

            '
          enum:
          - STOPPED
          - RUNNING
          - ERROR
          type: string
          x-obmcs-top-level-enum: '#/definitions/ProcessStatusType'
        timeLastProcessed:
          description: 'The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes.

            The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - name
      - processType
      - status
      - lastRecordLagInSeconds
      - timeLastProcessed
      type: object
    RecipeSummaryCollection:
      description: 'The list of Recipe objects.

        '
      properties:
        items:
          description: 'Array of Recipe Summary

            '
          items:
            $ref: '#/components/schemas/RecipeSummary'
          type: array
          x-default-description: 'null'
      required:
      - items
      type: object
    MaintenanceWindow:
      description: 'Defines the maintenance window, when automatic actions can be performed.

        '
      properties:
        day:
          description: 'Days of the week.

            '
          enum:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          - SUNDAY
          type: string
          x-obmcs-top-level-enum: '#/definitions/Day'
        startHour:
          description: 'Start hour for maintenance period. Hour is in UTC.

            '
          maximum: 23
          minimum: 0
          type: integer
      required:
      - day
      - startHour
      type: object
    StopPipelineDetails:
      description: 'Details for a pipeline stop.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'Type of a pipeline stop. This option applies when stopping a pipeline.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/StopPipelineType'
      required:
      - type
      type: object
    ResourceLock:
      description: 'Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        message:
          description: 'A message added by the creator of the lock. This is typically used to give an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

            '
          type: string
        timeCreated:
          description: When the lock was created.
          format: date-time
          type: string
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    ConnectionAssignmentCollection:
      description: 'List of connection summary objects.

        '
      properties:
        items:
          description: 'An array of Connection Assignment summaries.

            '
          items:
            $ref: '#/components/schemas/ConnectionAssignmentSummary'
          type: array
      required:
      - items
      type: object
    MessageSummary:
      description: 'Deployment message Summary.

        '
      properties:
        deploymentMessage:
          description: 'The deployment Message in plain text with optional HTML anchor tags.

            '
          maxLength: 255
          minLength: 0
          type: string
        deploymentMessageStatus:
          description: 'The deployment Message Status.

            '
          enum:
          - INFO
          - WARNING
          - ERROR
          type: string
        id:
          description: 'The deployment Message Id.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - id
      - deploymentMessage
      - deploymentMessageStatus
      type: object
    UpdateDeploymentBackupDetails:
      description: 'The information to use to update a Deployment Backup.

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
      type: object
    ConnectionCollection:
      description: 'List of connection summary objects.

        '
      properties:
        items:
          description: 'An array of Connection summaries.

            '
          items:
            $ref: '#/components/schemas/ConnectionSummary'
          type: array
      required:
      - items
      type: object
    TestPipelineConnectionDetails:
      description: 'Details about testing the pipeline''s assigned connection.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'Type of test for an assigned pipeline connection. This option applies when testing a pipeline connection.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/TestPipelineConnectionType'
      required:
      - type
      type: object
      x-example: "{\n  \"type\": \"DEFAULT\"\n}\n"
    DisasterRecoveryPrecheckResult:
      description: A single precheck result.
      properties:
        code:
          description: 'The code returned when GoldenGate reports an error while running a step during pipeline initialization.

            https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2

            '
          type: string
        correctiveAction:
          description: 'The corrective action for non-passing checks. Null for passed checks.

            '
          type: string
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: 'UUID to uniquely identify the each check result.

            '
          maxLength: 255
          minLength: 1
          type: string
        relatedResourceId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource related to the corresponding check.

            '
          maxLength: 255
          minLength: 1
          type: string
        relatedResourceType:
          description: 'Type of resource related to corresponding check.

            '
          enum:
          - GOLDENGATEDEPLOYMENT
          - GOLDENGATECONNECTION
          - VAULTSECRET
          type: string
          x-obmcs-top-level-enum: '#/definitions/RelatedResourceType'
        status:
          description: Status of the DR precheck result.
          enum:
          - SUCCEEDED
          - IN_PROGRESS
          - FAILED
          - NEEDS_ATTENTION
          type: string
          x-obmcs-top-level-enum: '#/definitions/PrecheckStatus'
      required:
      - key
      - displayName
      - description
      - status
      - relatedResourceId
      - relatedResourceType
      - code
      type: object
    LibraryUrl:
      description: 'A Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.

        '
      properties:
        url:
          description: 'The URL of a resource.

            '
          minLength: 0
          type: string
      required:
      - url
      type: object
    UpdateBackupScheduleDetails:
      description: 'Defines the backup schedule details for update operation.

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        frequencyBackupScheduled:
          description: 'The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.

            '
          enum:
          - DAILY
          - WEEKLY
          - MONTHLY
          type: string
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        timeBackupScheduled:
          description: 'The start timestamp for the deployment backup schedule. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

            '
          format: date-time
          type: string
      type: object
    AiModelSummary:
      description: 'Summary details of an AI model supported by a provider.

        '
      properties:
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: 'The identifier of the AI model offered by a provider.

            '
          maxLength: 255
          minLength: 1
          type: string
        providerType:
          description: 'AI Provider type used by the AI Model Connection.

            '
          enum:
          - OCI_GENERATIVE_AI
          - GEMINI
          - OPEN_AI
          - VOYAGE_AI
          type: string
      required:
      - key
      - providerType
      - displayName
      - description
      type: object
    CollectDeploymentDiagnosticDetails:
      description: 'Details for collecting deployment diagnostic

        '
      properties:
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        diagnosticNamePrefix:
          description: Prefix of the diagnostic collected and uploaded to object storage
          maxLength: 128
          minLength: 1
          pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
          type: string
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        timeDiagnosticEnd:
          description: The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
          format: date-time
          type: string
        timeDiagnosticStart:
          description: The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
          format: date-time
          type: string
      required:
      - namespaceName
      - bucketName
      - diagnosticNamePrefix
      type: object
    PipelineSchemaSummary:
      description: 'List of source and target schemas of a pipeline''s assigned connection.

        1. If there is no explicit mapping defined for the pipeline then only matched source and target schema names will be returned.

        2. If there are explicit mappings defined for the pipeline then along with the mapped source and target schema names, the matched source and target schema names also will be returned.

        '
      properties:
        sourceSchemaName:
          description: 'The schema name from the database connection.

            '
          example: HR or MOVIE
          minLength: 2
          type: string
        targetSchemaName:
          description: 'The schema name from the database connection.

            '
          example: HR or MOVIE
          minLength: 2
          type: string
      required:
      - sourceSchemaName
      - targetSchemaName
      type: object
    ConnectionSummary:
      description: 'Summary of the Connection.

        '
      discriminator:
        propertyName: connectionType
      properties:
        clusterPlacementGroupId:
          description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

            Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

            subscription id is provided. Otherwise the cluster placement group must not be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        connectionType:
          description: 'The connection type.

            '
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        doesUseSecretIds:
          default: false
          description: 'Indicates that sensitive attributes are provided via Secrets.


            Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID

            attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes. This change follows

            the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            When set to `true`, all sensitive information must be provided as OCI Vault secrets using the corresponding

            `*SecretId` attributes of the connection (for example, `passwordSecretId`). Plain-text sensitive attributes (for example, `password`) must not be used.

            This ensures that sensitive information remains stored and managed in the customer''s OCI Vault rather than by the GoldenGate service.


            When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, `password`) rather than in secret OCID attributes.

            In this mode, the sensitive information is stored by the GoldenGate service. If `vaultId` and `keyId` are not specified,

            the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.


            If `vaultId` and `keyId` are provided, the specified customer-managed key is used.

            '
          type: boolean
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        ingressIps:
          description: "List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. \nCustomers may optionally set up ingress security rules to restrict traffic from these IP addresses.\n"
          items:
            $ref: '#/components/schemas/IngressIpDetails'
          type: array
          x-default-description: 'null'
        keyId:
          description: 'References the OCI Vault key in the OCI Vault identified by `vaultId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API.

            This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided,

            the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data.

            If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.

            '
          maxLength: 255
          minLength: 0
          type: string
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for connection.

            '
          type: string
          x-obmcs-enumref: '#/definitions/Connection/lifecycleState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        nsgIds:
          description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 5
          type: array
        routingMethod:
          description: "Controls the network traffic direction to the target:\nSHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.\nDEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.\nSHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. \n\nDeprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method.\nThis change follows the GoldenGate \"Plain Text Fields in Connections\" deprecation:\nhttps://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate\n"
          enum:
          - SHARED_SERVICE_ENDPOINT
          - SHARED_DEPLOYMENT_ENDPOINT
          - DEDICATED_ENDPOINT
          type: string
          x-default-description: 'null'
          x-obmcs-top-level-enum: '#/definitions/RoutingMethod'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

                '
              type: object
            description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

            '
          maxLength: 255
          minLength: 0
          type: string
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        vaultId:
          description: 'References the OCI Vault that contains the customer-managed encryption key identified by `keyId`.


            Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

            corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

            attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

            https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


            This field is applicable only when `doesUseSecretIds` is set to `false`.

            If `vaultId` is provided, `keyId` must also be provided.

            '
          maxLength: 255
          minLength: 0
          type: string
      required:
      - connectionType
      - id
      - displayName
      - compartmentId
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    DeploymentBackupSummary:
      description: 'The summary of the Backup.

        '
      properties:
        backupSourceType:
          description: 'Possible deployment backup source types.

            '
          enum:
          - MANUAL
          - AUTOMATIC
          - SCHEDULED
          type: string
        backupType:
          description: 'Possible Deployment backup types.

            '
          enum:
          - INCREMENTAL
          - FULL
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentBackupType'
        bucketName:
          description: Name of the bucket where the object is to be uploaded in the object storage
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        deploymentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        deploymentType:
          description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
          enum:
          - OGG
          - DATABASE_ORACLE
          - BIGDATA
          - DATABASE_MICROSOFT_SQLSERVER
          - DATABASE_MYSQL
          - DATABASE_POSTGRESQL
          - DATABASE_DB2ZOS
          - DATABASE_DB2I
          - GGSA
          - DATA_TRANSFORMS
          - VERIDATA_SERVER
          - VERIDATA_AGENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentType'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        isAutomatic:
          description: 'True if this object is automatically created

            '
          type: boolean
          x-default-description: false
        isMetadataOnly:
          default: false
          description: Parameter to allow users to create backup without trails
          type: boolean
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Possible lifecycle states for a Deployment Backup.

            '
          type: string
          x-obmcs-enumref: '#/definitions/DeploymentBackup/lifecycleState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        namespaceName:
          description: Name of namespace that serves as a container for all of your buckets
          type: string
        objectName:
          description: Name of the object to be uploaded to object storage
          type: string
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        sizeInBytes:
          description: 'The size of the backup stored in object storage (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        timeBackupFinished:
          description: 'The time of the resource backup finish. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
          x-default-description: 'null'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeOfBackup:
          description: 'The time of the resource backup. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
          x-default-description: 'null'
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - id
      - deploymentId
      - deploymentType
      - compartmentId
      - lifecycleState
      - oggVersion
      type: object
    ChangeConnectionSubscriptionDetails:
      allOf:
      - $ref: '#/components/schemas/ChangeSubscriptionDetails'
      description: 'The configuration details for associating the GoldenGate connection resource with a different subscription.

        '
    StopDeploymentDetails:
      description: The information about the Stop for a Deployment.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a deployment stop

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/StopDeploymentType'
      required:
      - type
      type: object
    CreateOggDeploymentDetails:
      description: 'Deployment Data for creating an OggDeployment

        '
      properties:
        adminPassword:
          description: 'The password associated with the GoldenGate deployment console username.

            The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric,

            and 1 special character. Special characters such as ''$'', ''^'', or ''?'' are not allowed.

            This field will be deprecated and replaced by "passwordSecretId".

            '
          example: secret-A1
          format: password
          maxLength: 30
          minLength: 1
          pattern: (?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*
          type: string
        adminUsername:
          description: 'The GoldenGate deployment console username.

            '
          example: oggadmin
          maxLength: 512
          minLength: 0
          type: string
        certificate:
          description: 'The base64 encoded content of the PEM file containing the SSL certificate.

            '
          maxLength: 65536
          minLength: 0
          type: string
        credentialStore:
          default: GOLDENGATE
          description: 'The type of credential store for OGG.

            '
          enum:
          - GOLDENGATE
          - IAM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialStore'
        deploymentName:
          description: 'The name given to the GoldenGate service deployment.

            The name must contain only alphanumeric characters and must start with a letter.

            For standby deployment the deployment name is inherited from primary.

            '
          maxLength: 32
          minLength: 0
          pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
          type: string
        groupToRolesMapping:
          $ref: '#/components/schemas/GroupToRolesMappingDetails'
        identityDomainId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: 'The base64 encoded content of the PEM file containing the private key.

            '
          format: password
          maxLength: 8192
          minLength: 0
          type: string
        keySecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format.

            '
          maxLength: 255
          minLength: 0
          type: string
        oggVersion:
          description: 'Version of OGG

            '
          minLength: 1
          type: string
        passwordSecretId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    SourcePipelineConnectionDetails:
      description: 'The source connection details for creating a pipeline.

        '
      properties:
        connectionId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

            referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - connectionId
      type: object
    PipelineSchemaCollection:
      description: 'The list of schemas present in the source/target connection database of a pipeline.

        '
      properties:
        items:
          description: 'Array of pipeline schemas

            '
          items:
            $ref: '#/components/schemas/PipelineSchemaSummary'
          type: array
          x-default-description: 'null'
      required:
      - items
      type: object
    RecipeSummary:
      description: 'The list of recipe details to create pipelines.

        '
      properties:
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        name:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        recipeType:
          description: 'The type of the recipe

            '
          enum:
          - ZERO_ETL
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecipeType'
        supportedSourceTechnologyTypes:
          description: 'Array of supported technology types for this recipe.

            '
          items:
            $ref: '#/components/schemas/TechnologyType'
          minItems: 1
          type: array
        supportedTargetTechnologyTypes:
          description: 'Array of supported technology types for this recipe.

            '
          items:
            $ref: '#/components/schemas/TechnologyType'
          minItems: 1
          type: array
      required:
      - recipeType
      - name
      - displayName
      - supportedSourceTechnologyTypes
      - supportedTargetTechnologyTypes
      type: object
    RefreshConnectionDetails:
      description: The information about the Refresh Connection external attributes.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a refresh Connection external attributes.

            '
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/RefreshConnectionType'
      required:
      - type
      type: object
    ChangeSubscriptionDetails:
      description: 'The configuration details for associating the resource with a different subscription.

        '
      properties:
        isDefault:
          description: 'Indicates if the subscription is UCM or not.

            '
          type: boolean
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
          maxLength: 255
          minLength: 0
          type: string
      type: object
    PipelineSummary:
      description: 'Summary details of the pipeline.

        '
      discriminator:
        propertyName: recipeType
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
        cpuCoreCount:
          description: 'The Minimum number of OCPUs to be made available for this Deployment.

            '
          maximum: 24
          minimum: 1
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
          x-default-description: 'null'
        description:
          description: 'Metadata about this specific object.

            '
          maxLength: 400
          minLength: 0
          type: string
          x-default-description: 'null'
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

            for cross-compatibility only.


            Example: `{"bar-key": "value"}`

            '
          type: object
          x-default-description: 'null'
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.

            '
          maxLength: 255
          minLength: 1
          type: string
        isAutoScalingEnabled:
          description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

            '
          type: boolean
        licenseModel:
          description: 'The Oracle license model that applies to a Deployment.

            '
          enum:
          - LICENSE_INCLUDED
          - BRING_YOUR_OWN_LICENSE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseModel'
        lifecycleDetails:
          description: 'Describes the object''s current state in detail. For example, it can be used to provide

            actionable information for a resource in a Failed state.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'Lifecycle state for the pipeline summary.

            '
          type: string
          x-obmcs-enumref: '#/definitions/Pipeline/lifecycleState'
        lifecycleSubState:
          description: 'Possible lifecycle substates when retrieving a pipeline.

            '
          enum:
          - STARTING
          - STOPPING
          - STOPPED
          - MOVING
          - RUNNING
          - PAUSING
          - PAUSED
          - START_FAILED
          - STOP_FAILED
          - PAUSE_FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleSubState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        recipeType:
          description: 'The type of the recipe

            '
          enum:
          - ZERO_ETL
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecipeType'
        sourceConnectionDetails:
          $ref: '#/components/schemas/SourcePipelineConnectionDetails'
        subnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline''s private endpoint.

            The subnet must be a private subnet.

            '
          maxLength: 255
          minLength: 0
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

            Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

            information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
          x-default-description: 'null'
        targetConnectionDetails:
          $ref: '#/components/schemas/TargetPipelineConnectionDetails'
        timeCreated:
          description: 'The time the resource was created. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - recipeType
      - id
      - displayName
      - compartmentId
      - sourceConnectionDetails
      - targetConnectionDetails
      - licenseModel
      - cpuCoreCount
      - isAutoScalingEnabled
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    AiModelCollection:
      description: 'Collection of AI models currently known by GoldenGate for the specified provider.

        '
      properties:
        items:
          description: 'An array of AI models.

            '
          items:
            $ref: '#/components/schemas/AiModelSummary'
          maxItems: 100
          type: array
      required:
      - items
      type: object
    TrailSequenceSummary:
      description: 'Summary of the TrailSequences.

        '
      properties:
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        sequenceId:
          description: 'Sequence Id

            '
          maxLength: 12
          minLength: 0
          type: string
        sizeInBytes:
          description: 'The size of the backup stored in object storage (in bytes)

            '
          format: int64
          type: integer
          x-default-description: 0
        timeLastUpdated:
          description: 'The time the resource was last updated. The format is defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

            '
          format: date-time
          type: string
      required:
      - sequenceId
      type: object
    PipelineSchemaTableCollection:
      description: 'List of source or target schema tables of a pipeline''s assigned connection.

        '
      properties:
        items:
          description: 'Array of source or target schema tables of a pipeline''s assigned connection.

            '
          items:
            $ref: '#/components/schemas/PipelineSchemaTableSummary'
          type: array
          x-default-description: 'null'
        sourceSchemaName:
          description: 'The schema name from the database connection.

            '
          example: HR or MOVIE
          minLength: 2
          type: string
        targetSchemaName:
          description: 'The schema name from the database connection.

            '
          example: HR or MOVIE
          minLength: 2
          type: string
      required:
      - items
      type: object
    DeploymentEnvironmentSummary:
      description: 'The metadata specific to a production or development/testing environment.

        '
      properties:
        category:
          description: 'The deployment category defines the broad separation of the deployment type into four categories.

            Currently the separation is ''DATA_REPLICATION'', ''STREAM_ANALYTICS'', ''DATA_TRANSFORMS'' and ''DATA_VERIFICATION''.

            '
          enum:
          - DATA_REPLICATION
          - STREAM_ANALYTICS
          - DATA_TRANSFORMS
          - DATA_VERIFICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/DeploymentCategory'
        defaultCpuCoreCount:
          description: 'The default CPU core count.

            '
          maximum: 24
          minimum: 1
          type: integer
        displayName:
          description: 'An object''s Display Name.

            '
          maxLength: 255
          minLength: 1
          type: string
        environmentType:
          description: 'Specifies whether the deployment is used in a production or development/testing environment.

            '
          enum:
          - PRODUCTION
          - DEVELOPMENT_OR_TESTING
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
        isAutoScalingEnabledByDefault:
          description: 'Specifies whether the "Auto scaling" option should be enabled by default or not.

            '
          type: boolean
        maxCpuCoreCount:
          description: 'The maximum CPU core count.

            '
          maximum: 24
          minimum: 1
          type: integer
        memoryPerOcpuInGBs:
          description: 'The multiplier value between CPU core count and memory size.

            '
          minimum: 1
          type: integer
        minCpuCoreCount:
          description: 'The minimum CPU core count.

            '
          maximum: 24
          minimum: 1
          type: integer
        networkBandwidthPerOcpuInGbps:
          description: 'The multiplier value between CPU core count and network bandwidth.

            '
          minimum: 1
          type: integer
        storageUsageLimitPerOcpuInGBs:
          description: 'The multiplier value between CPU core count and storage usage limit size.

            '
          minimum: 1
          type: integer
      required:
      - environmentType
      - category
      - minCpuCoreCount
      - defaultCpuCoreCount
      - maxCpuCoreCount
      - isAutoScalingEnabledByDefault
      - networkBandwidthPerOcpuInGbps
      - memoryPerOcpuInGBs
      - storageUsageLimitPerOcpuInGBs
      type: object
    ChangeConnectionCompartmentDetails:
      description: 'The new compartment for a Connection.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    AddResourceLockDetails:
      description: 'Used to add a resource lock.

        Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        message:
          description: 'A message added by the creator of the lock. This is typically used to give an

            indication of why the resource is locked.

            '
          type: string
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    MigrateConnectionDetails:
      description: The information about the Migrate Connection.
      discriminator:
        propertyName: type
      properties:
        type:
          description: 'The type of a migrate Connection.

            '
          enum:
          - SECRET
          type: string
          x-obmcs-top-level-enum: '#/definitions/MigrateConnectionType'
      required:
      - type
      type: object
  parameters:
    DeploymentPeerLifecycleStateQueryParam:
      description: 'A filter to return only the deployment peers having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/DeploymentPeerSummary/lifecycleState'
      schema:
        type: string
    AvailabilityDomainQueryParam:
      description: 'The availability domain of the placement to evaluate DR pre-checks for.

        '
      in: query
      name: availabilityDomain
      required: true
      x-example: Uocm:PHX-AD-1
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DeploymentBackupLifecycleStateQueryParam:
      description: 'A filter to return only the deployment backups having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/DeploymentBackup/lifecycleState'
      schema:
        type: string
    FaultDomainQueryParam:
      description: 'The fault domain of the placement to evaluate DR pre-checks for.

        '
      in: query
      name: faultDomain
      required: true
      x-example: FAULT-DOMAIN-1
      schema:
        type: string
        maxLength: 255
        minLength: 1
    AssignableDeploymentIdQueryParam:
      description: 'Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.

        '
      in: query
      name: assignableDeploymentId
      required: false
      x-default-description: 'null'
      x-example: ?assignableDeploymentId=ocid1.goldengatedeployment.oc1.phx.amaaaaaarhwbfeqaya2afgrlevohhzhlrj3zenpg456455eeqm4pimr76z7zzq
      schema:
        type: string
    RecipeTypeQueryParam:
      description: 'The pipeline''s recipe type. The default value is ZERO_ETL.

        '
      in: query
      name: recipeType
      x-obmcs-top-level-enum: '#/definitions/RecipeType'
      schema:
        type: string
        enum:
        - ZERO_ETL
        default: ZERO_ETL
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the

        `if-match` parameter to the value of the etag from a previous GET or POST response for that

        resource.  The resource is updated or deleted only if the etag you provide matches the

        resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    ReqTrailFileIdQueryParam:
      description: 'A Trail File identifier

        '
      in: query
      name: trailFileId
      required: true
      x-example: EA
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PipelineIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline created.

        '
      in: path
      name: pipelineId
      required: true
      x-default-description: 'null'
      x-example: ocid1.goldengatepipeline.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DeploymentIdentifierPathParam:
      description: 'A unique Deployment identifier.

        '
      in: path
      name: deploymentId
      required: true
      x-example: ocid1.ggsdeployment.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    AiModelRegionQueryParam:
      description: 'OCI region identifier, for example us-ashburn-1.

        '
      in: query
      name: region
      required: false
      x-default-description: the current region
      x-example: ?region=us-ashburn-1
      schema:
        type: string
    DeploymentTypeSelectorQueryParam:
      description: 'A filter that returns only the resources matching the specified ''deploymentType''.

        '
      in: query
      name: deploymentType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/DeploymentType'
      schema:
        type: string
        enum:
        - OGG
        - DATABASE_ORACLE
        - BIGDATA
        - DATABASE_MICROSOFT_SQLSERVER
        - DATABASE_MYSQL
        - DATABASE_POSTGRESQL
        - DATABASE_DB2ZOS
        - DATABASE_DB2I
        - GGSA
        - DATA_TRANSFORMS
        - VERIDATA_SERVER
        - VERIDATA_AGENT
    SortOrderQueryParam:
      description: 'The sort order to use, either ''asc'' or ''desc''.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    AiProviderTypeQueryParam:
      description: 'The AI provider type for which model information is requested.

        '
      in: query
      name: providerType
      required: true
      x-example: ?providerType=OCI_GENERATIVE_AI
      x-obmcs-enumref: '#/definitions/AiProviderSummary/providerType'
      schema:
        type: string
    RequestIdHeader:
      description: 'The client request ID for tracing.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    CertificateKeyPathParam:
      description: 'A unique certificate identifier.

        '
      in: path
      name: certificateKey
      required: true
      x-example: 5d3a253e-f806-46d5-b4ce-168a823a1181
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleStateQueryParam:
      description: 'A filter to return only the resources that match the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - INACTIVE
        - DELETING
        - DELETED
        - FAILED
        - NEEDS_ATTENTION
        - IN_PROGRESS
        - CANCELING
        - CANCELED
        - SUCCEEDED
        - WAITING
    OptionalRequestId:
      description: 'Unique identifier for the request.

        '
      in: header
      name: opc-request-id
      required: false
      schema:
        type: string
    WalletSortByQueryParam:
      description: 'The field to sort by. Only one sort order can be provided. Default order for ''timeStarted'' is

        descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeStarted
        default: timeStarted
    AddResourceLockDetailsBodyParam:
      description: AddResourceLockDetails body parameter
      in: body
      name: AddResourceLockDetails
      required: true
      schema:
        $ref: '#/components/schemas/AddResourceLockDetails'
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order can be provided. Default order for ''timeCreated'' is

        descending.  Default order for ''displayName'' is ascending. If no value is specified

        timeCreated is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    TargetSchemaNameQueryParam:
      description: 'Name of the target schema obtained from get schema endpoint of the created pipeline.

        '
      in: query
      name: targetSchemaName
      required: true
      x-example: GGUSER%25
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SupportedConnectionTypeQueryParam:
      description: 'The connection type which the deployment must support.

        '
      in: query
      name: supportedConnectionType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/ConnectionType'
      schema:
        type: string
        enum:
        - GOLDENGATE
        - KAFKA
        - KAFKA_SCHEMA_REGISTRY
        - MYSQL
        - JAVA_MESSAGE_SERVICE
        - MICROSOFT_SQLSERVER
        - OCI_OBJECT_STORAGE
        - ORACLE
        - AZURE_DATA_LAKE_STORAGE
        - POSTGRESQL
        - AZURE_SYNAPSE_ANALYTICS
        - SNOWFLAKE
        - AMAZON_S3
        - HDFS
        - ORACLE_AI_DATA_PLATFORM
        - ORACLE_NOSQL
        - MONGODB
        - AMAZON_KINESIS
        - AMAZON_REDSHIFT
        - DB2
        - REDIS
        - ELASTICSEARCH
        - GENERIC
        - GOOGLE_CLOUD_STORAGE
        - GOOGLE_BIGQUERY
        - DATABRICKS
        - GOOGLE_PUBSUB
        - MICROSOFT_FABRIC
        - ICEBERG
        - AI_MODEL
    DeploymentLifecycleStateQueryParam:
      description: 'A filter to return only the deployments having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/Deployment/lifecycleState'
      schema:
        type: string
    ConnectionTypeQueryParam:
      description: 'The array of connection types.

        '
      in: query
      name: connectionType
      required: false
      x-default-description: 'null'
      x-example: ?connectionType=KAFKA&connectionType=ORACLE
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
    WorkRequestIdPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request.

        '
      in: path
      name: workRequestId
      required: true
      x-example: ocid1..oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    TechnologyTypeQueryParam:
      description: 'The array of technology types.

        '
      in: query
      name: technologyType
      required: false
      x-default-description: 'null'
      x-example: ?technologyType=ORACLE_EXADATA&technologyType=ORACLE_EXADATA
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - GOLDENGATE
          - GENERIC
          - OCI_AUTONOMOUS_DATABASE
          - OCI_AUTONOMOUS_JSON_DATABASE
          - OCI_CACHE_WITH_REDIS
          - OCI_MYSQL
          - OCI_OBJECT_STORAGE
          - OCI_POSTGRESQL
          - OCI_STREAMING
          - OCI_STREAMING_WITH_APACHE_KAFKA
          - ORACLE_DATABASE
          - ORACLE_EXADATA
          - ORACLE_EXADATA_EXASCALE
          - ORACLE_EXADATA_DATABASE_AT_AZURE
          - ORACLE_EXADATA_EXASCALE_AT_AZURE
          - ORACLE_AUTONOMOUS_DATABASE_AT_AZURE
          - ORACLE_JSON_COLLECTION
          - ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD
          - ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD
          - ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD
          - ORACLE_EXADATA_DATABASE_AT_AWS
          - ORACLE_AUTONOMOUS_DATABASE_AT_AWS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - ORACLE_REST_DATA_SERVICES
          - ORACLE_WEBLOGIC_JMS
          - AMAZON_RDS_ORACLE
          - AMAZON_RDS_SQLSERVER
          - AMAZON_S3
          - AMAZON_AURORA_MYSQL
          - AMAZON_AURORA_POSTGRESQL
          - AMAZON_DOCUMENT_DB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - AMAZON_RDS_MARIADB
          - AMAZON_RDS_MYSQL
          - AMAZON_RDS_POSTGRESQL
          - APACHE_ICEBERG
          - APACHE_KAFKA
          - AZURE_COSMOS_DB_FOR_MONGODB
          - AZURE_COSMOS_DB_FOR_POSTGRESQL
          - AZURE_DATA_LAKE_STORAGE
          - AZURE_EVENT_HUBS
          - AZURE_MYSQL
          - AZURE_POSTGRESQL
          - AZURE_SQLSERVER_MANAGED_INSTANCE
          - AZURE_SQLSERVER_NON_MANAGED_INSTANCE
          - AZURE_SYNAPSE_ANALYTICS
          - CONFLUENT_KAFKA
          - CONFLUENT_SCHEMA_REGISTRY
          - DATABRICKS
          - DB2_I
          - DB2_ZOS
          - ELASTICSEARCH
          - EDB_POSTGRES_ADVANCED_SERVER
          - GOOGLE_ALLOY_DB_FOR_POSTGRESQL
          - GOOGLE_BIGQUERY
          - GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_CLOUD_SQL_MYSQL
          - GOOGLE_CLOUD_SQL_POSTGRESQL
          - GOOGLE_CLOUD_SQL_SQLSERVER
          - GOOGLE_PUBSUB
          - HDFS
          - MARIADB
          - MICROSOFT_SQLSERVER
          - MICROSOFT_FABRIC_EVENTSTREAM
          - MICROSOFT_FABRIC_LAKEHOUSE
          - MICROSOFT_FABRIC_MIRROR
          - MONGODB
          - MYSQL_SERVER
          - MYSQL_HEATWAVE_ON_AZURE
          - MYSQL_HEATWAVE_ON_AWS
          - POSTGRESQL_SERVER
          - REDIS
          - SINGLESTOREDB
          - SINGLESTOREDB_CLOUD
          - SNOWFLAKE
          - YUGABYTE_DB
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/TechnologyType'
    AliasNameQueryParam:
      description: The name of the connection in the assignment (aliasName).
      in: query
      name: name
      required: false
      x-default-description: 'null'
      x-example: ?aliasName=example
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ConnectionAssignmentIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Connection Assignment.

        '
      in: path
      name: connectionAssignmentId
      required: true
      x-example: ocid1.ggsconnection.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ConnectionLifecycleStateQueryParam:
      description: 'A filter to return only connections having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/Connection/lifecycleState'
      schema:
        type: string
    ConnectionAssignmentLifecycleStateQueryParam:
      description: A filter to return only connection assignments having the 'lifecycleState' given.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ConnectionAssignment/lifecycleState'
      schema:
        type: string
    TrailSequenceIdQueryParam:
      description: 'A Trail Sequence identifier

        '
      in: query
      name: trailSequenceId
      required: false
      x-example: '000000001'
      schema:
        type: string
        maxLength: 9
        minLength: 1
    DisplayNameQueryParam:
      description: 'A filter to return only the resources that match the entire ''displayName'' given.

        '
      in: query
      name: displayName
      x-default-description: 'null'
      x-example: Example Object
      schema:
        type: string
        maxLength: 255
        minLength: 1
    FqdnQueryParam:
      description: 'A filter to return only the resources that match the ''fqdn'' given.

        '
      in: query
      name: fqdn
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 253
        minLength: 4
    DeploymentIdentifierQueryParam:
      description: 'A unique Deployment identifier.

        '
      in: query
      name: deploymentId
      required: true
      x-example: ocid1.ggsdeployment.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    AssignableDeploymentTypeQueryParam:
      description: 'Filters for connections which can be assigned to the latest version of the specified deployment type.

        '
      in: query
      name: assignableDeploymentType
      required: false
      x-default-description: 'null'
      x-example: ?assignableDeploymentType=DATABASE_MYSQL
      x-obmcs-top-level-enum: '#/definitions/DeploymentType'
      schema:
        type: string
        enum:
        - OGG
        - DATABASE_ORACLE
        - BIGDATA
        - DATABASE_MICROSOFT_SQLSERVER
        - DATABASE_MYSQL
        - DATABASE_POSTGRESQL
        - DATABASE_DB2ZOS
        - DATABASE_DB2I
        - GGSA
        - DATA_TRANSFORMS
        - VERIDATA_SERVER
        - VERIDATA_AGENT
    AssignableConnectionIdQueryParam:
      description: 'Return the deployments to which the specified connectionId may be assigned.

        '
      in: query
      name: assignableConnectionId
      required: false
      x-default-description: 'null'
      x-example: ?assignableConnectionId=ocid1.goldengateconnection.oc1.phx.amaaaaaarhwbfeqaya2afgrlevohhzhlrj3zenpg456455eeqm4pimr76z7zzq
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'The page token representing the page at which to start retrieving results. This is usually

        retrieved from a previous list call.

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    OggVersionQueryParam:
      description: 'Allows to query by a specific GoldenGate version.

        '
      in: query
      name: oggVersion
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    DeploymentIdQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources.

        '
      in: query
      name: deploymentId
      required: false
      x-default-description: 'null'
      x-example: ocid1.ggsdeployment.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DeploymentBackupIdentifierPathParam:
      description: 'A unique DeploymentBackup identifier.

        '
      in: path
      name: deploymentBackupId
      required: true
      x-example: ocid1.ggsdeploymentbackup.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ConnectionDetailsViewParam:
      description: 'Selects the connection fields returned in connection details.

        '
      in: query
      name: view
      required: false
      x-example: ?view=COMPACT
      schema:
        type: string
        enum:
        - FULL
        - COMPACT
        default: FULL
    DeploymentUpgradeLifecycleStateQueryParam:
      description: 'A filter to return only the deployment upgrades having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/DeploymentUpgrade/lifecycleState'
      schema:
        type: string
    DatabaseRegistrationIdentifierPathParam:
      description: 'A unique DatabaseRegistration identifier.

        '
      in: path
      name: databaseRegistrationId
      required: true
      x-example: ocid1.ggsdatabaseregistration.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RetryTokenHeader:
      description: "A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, \nwithout the risk of executing that same action again. Retry tokens expire after 24 hours but can be \ninvalidated before then due to conflicting operations. For example, if a resource was deleted and purged \nfrom the system, then a retry of the original creation request is rejected.\n"
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 128
        minLength: 1
    AiModelTenancyIdQueryParam:
      description: 'OCI tenancy OCID to use when resolving provider models, for example for

        OCI Generative AI model discovery across a specific tenancy.

        '
      in: query
      name: tenancyId
      required: false
      x-default-description: the current tenancy
      x-example: ?tenancyId=ocid1.tenancy.oc1..exampleuniqueID
      schema:
        type: string
    SourceSchemaNameQueryParam:
      description: 'Name of the source schema obtained from get schema endpoint of the created pipeline.

        '
      in: query
      name: sourceSchemaName
      required: true
      x-example: GGUSER%25
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PipelineLifecycleSubStateQueryParam:
      description: 'A filtered list of pipelines to return for a given lifecycleSubState.

        '
      in: query
      name: lifecycleSubState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleSubState'
      schema:
        type: string
        enum:
        - STARTING
        - STOPPING
        - STOPPED
        - MOVING
        - RUNNING
        - PAUSING
        - PAUSED
        - START_FAILED
        - STOP_FAILED
        - PAUSE_FAILED
    CertificateLifecycleStateQueryParam:
      description: 'A filter to return only connections having the ''lifecycleState'' given.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
    AssignedDeploymentIdQueryParam:
      description: 'The OCID of the deployment which for the connection must be assigned.

        '
      in: query
      name: assignedDeploymentId
      required: false
      x-default-description: 'null'
      x-example: ?assignedDeploymentId=ocid1.goldengatedeployment.oc1.phx.amaaaaaarhwbfeqaya2afgrlevohhzhlrj3zenpg456455eeqm4pimr76z7zzq
      schema:
        type: string
    ConnectionTypeNotEqualToQueryParam:
      description: 'The array of connection types to exclude.

        '
      in: query
      name: connectionTypeNotEqualTo
      required: false
      x-default-description: 'null'
      x-example: ?connectionTypeNotEqualTo=KAFKA&connectionTypeNotEqualTo=ORACLE
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - GOLDENGATE
          - KAFKA
          - KAFKA_SCHEMA_REGISTRY
          - MYSQL
          - JAVA_MESSAGE_SERVICE
          - MICROSOFT_SQLSERVER
          - OCI_OBJECT_STORAGE
          - ORACLE
          - AZURE_DATA_LAKE_STORAGE
          - POSTGRESQL
          - AZURE_SYNAPSE_ANALYTICS
          - SNOWFLAKE
          - AMAZON_S3
          - HDFS
          - ORACLE_AI_DATA_PLATFORM
          - ORACLE_NOSQL
          - MONGODB
          - AMAZON_KINESIS
          - AMAZON_REDSHIFT
          - DB2
          - REDIS
          - ELASTICSEARCH
          - GENERIC
          - GOOGLE_CLOUD_STORAGE
          - GOOGLE_BIGQUERY
          - DATABRICKS
          - GOOGLE_PUBSUB
          - MICROSOFT_FABRIC
          - ICEBERG
          - AI_MODEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
    CompartmentIdQueryParam:
      description: "The OCID of the compartment that contains the work request. Work requests should be scoped \nto the same compartment as the resource the work request affects. If the work request concerns \nmultiple resources, and those resources are not in the same compartment, it is up to the service team \nto pick the primary resource whose compartment should be used.\n"
      in: query
      name: compartmentId
      required: true
      x-example: ocid1.compartment.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleSubStateQueryParam:
      description: 'A filter to return only the resources that match the ''lifecycleSubState'' given.

        '
      in: query
      name: lifecycleSubState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
      schema:
        type: string
        enum:
        - RECOVERING
        - STARTING
        - STOPPING
        - MOVING
        - UPGRADING
        - RESTORING
        - BACKUP_IN_PROGRESS
        - ROLLBACK_IN_PROGRESS
    ConnectionIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a Connection.

        '
      in: path
      name: connectionId
      required: true
      x-example: ocid1.goldengateconnection.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RemoveResourceLockDetailsBodyParam:
      description: RemoveResourceLockDetails body parameter
      in: body
      name: RemoveResourceLockDetails
      required: true
      schema:
        $ref: '#/components/schemas/RemoveResourceLockDetails'
    ConnectionIdQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection.

        '
      in: query
      name: connectionId
      required: false
      x-default-description: 'null'
      x-example: ocid1.goldengateconnection.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return.

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    TrailSortByQueryParam:
      description: 'The field to sort by. Only one sort order can be provided. Default order for ''timeLastUpdated'' is

        descending.  Default order for ''displayName'' is ascending. If no value is specified

        displayName is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeLastUpdated
        - displayName
        default: displayName
    PipelineLifecycleStateQueryParam:
      description: 'A filtered list of pipelines to return for a given lifecycleState.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/Pipeline/lifecycleState'
      schema:
        type: string
    AssignedConnectionIdQueryParam:
      description: 'The OCID of the connection which for the deployment must be assigned.

        '
      in: query
      name: assignedConnectionId
      required: false
      x-default-description: 'null'
      x-example: ?assignedConnectionId=ocid1.goldengateconnection.oc1.phx.amaaaaaarhwbfeqaya2afgrlevohhzhlrj3zenpgg6p5eeqm4pimr76z7zzq
      schema:
        type: string
    ResourceIdQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource in which to list resources.

        '
      in: query
      name: resourceId
      required: false
      x-example: ocid1.goldengatedeployment.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OverrideLocksQueryParameter:
      description: Whether to override locks (if any exist).
      in: query
      name: isLockOverride
      schema:
        type: boolean
        default: false
    TrailFileIdQueryParam:
      description: 'A Trail File identifier

        '
      in: query
      name: trailFileId
      required: false
      x-example: EA
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DeploymentUpgradeIdentifierPathParam:
      description: 'A unique Deployment Upgrade identifier.

        '
      in: path
      name: deploymentUpgradeId
      required: true
      x-example: ocid1.ggsdeploymentupgrade.oc1..aaaaaaaaqavsjcbq5ya6jqblflzc6ms453liw3sdbgg6zplb2eafirlrj33a
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DeploymentTypeQueryParam:
      description: 'The type of deployment, the value determines the exact ''type'' of the service executed in the deployment. Default value is DATABASE_ORACLE.

        '
      in: query
      name: deploymentType
      x-obmcs-top-level-enum: '#/definitions/DeploymentType'
      schema:
        type: string
        enum:
        - OGG
        - DATABASE_ORACLE
        - BIGDATA
        - DATABASE_MICROSOFT_SQLSERVER
        - DATABASE_MYSQL
        - DATABASE_POSTGRESQL
        - DATABASE_DB2ZOS
        - DATABASE_DB2I
        - GGSA
        - DATA_TRANSFORMS
        - VERIDATA_SERVER
        - VERIDATA_AGENT
        default: DATABASE_ORACLE
  responses:
    default:
      description: 'Unknown Error

        '
      headers:
        opc-request-id:
          description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

            particular request, please include the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: "The page token represents the page to start retrieving results. This is usually retrieved \nfrom a previous list call.\n"
      type: string
    opc-request-id:
      description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

        particular request, please include the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'A unique Oracle-assigned identifier for an asynchronous request. You can use this to query

        status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: 'The number of seconds the client should wait before polling this endpoint again.

        '
      type: integer
    sunset:
      description: 'Deprecation date of this API version.

        '
      type: string
  x-properties:
    MongoDbConnectionString:
      description: 'MongoDB connection string.

        e.g.: ''mongodb://mongodb0.example.com:27017/recordsrecords''

        '
      maxLength: 2000
      minLength: 0
      type: string
    actionOnDdlError:
      default: TERMINATE
      description: 'Action upon DDL Error (active only if ''Replicate schema changes (DDL)'' is selected) i.e canReplicateSchemaChange=true

        '
      enum:
      - TERMINATE
      - DISCARD
      - IGNORE
      type: string
      x-obmcs-top-level-enum: '#/definitions/ReplicateDdlErrorAction'
    actionOnDmlError:
      default: TERMINATE
      description: 'Action upon DML Error (active only if ''Replicate schema changes (DDL)'' is selected) i.e canReplicateSchemaChange=true

        '
      enum:
      - TERMINATE
      - DISCARD
      - IGNORE
      type: string
      x-obmcs-top-level-enum: '#/definitions/ReplicateDmlErrorAction'
    actionOnExistingTable:
      default: REPLACE
      description: 'Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true.

        '
      enum:
      - TRUNCATE
      - REPLACE
      - APPEND
      - SKIP
      type: string
      x-obmcs-top-level-enum: '#/definitions/InitialLoadAction'
    additionalAttributes:
      description: 'An array of name-value pair attribute entries.

        Used as additional parameters in connection string.

        '
      items:
        $ref: '#/components/schemas/NameValuePair'
      type: array
    administratorGroupId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup.

        It grants full access to the user, including the ability to alter general, non-security related operational parameters

        and profiles of the server.

        '
      maxLength: 255
      minLength: 0
      type: string
    aiModelApiKey:
      description: 'API key for the AI model connection.

        Deprecated: This field is deprecated and replaced by "apiKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 4000
      minLength: 0
      type: string
    aiModelApiKeySecretId:
      description: 'API key secret OCID for the AI model connection.

        '
      maxLength: 255
      minLength: 1
      type: string
    aiModelAuthType:
      description: 'Authentication type used by the AI model connection.

        '
      enum:
      - OCI_GEN_AI
      - API_KEY
      type: string
      x-obmcs-top-level-enum: '#/definitions/AiModelAuthType'
    aiModelBaseUrl:
      description: 'Base URL of the AI model endpoint.

        If not specified, the default base URL for the selected AI provider will be used.

        '
      maxLength: 1024
      minLength: 1
      type: string
    aiModelCompartmentId:
      description: 'OCI Generative AI compartment OCID.

        '
      maxLength: 255
      minLength: 1
      type: string
    aiModelKeyFingerprint:
      description: 'OCI Generative AI key fingerprint.

        '
      maxLength: 255
      minLength: 1
      type: string
    aiModelMaxInputChars:
      default: 20000
      description: 'Maximum number of input characters supported by this AI model connection.

        '
      minimum: 1
      type: integer
    aiModelModelKey:
      description: 'AI model identifier.

        '
      maxLength: 255
      minLength: 1
      type: string
    aiModelProviderType:
      description: 'AI Provider type used by the AI Model Connection.

        '
      enum:
      - OCI_GENERATIVE_AI
      - GEMINI
      - OPEN_AI
      - VOYAGE_AI
      type: string
    aiModelTechnologyType:
      description: 'The AI Model technology type.

        '
      type: string
      x-obmcs-enumref: '#/definitions/AiModelConnection/technologyType'
    aiModelTenancyId:
      description: 'OCI Generative AI tenancy OCID. If this value is not provided, or is updated to an empty

        value, it defaults to the tenancy OCID of the user who is executing the operation.

        '
      maxLength: 255
      minLength: 0
      type: string
    aiModelUserId:
      description: 'OCI Generative AI user OCID. If this value is not provided, or is updated to an empty

        value, it defaults to the OCID of the user who is executing the operation.

        '
      maxLength: 255
      minLength: 0
      type: string
    aiProviderAuthTypes:
      description: 'Authentication types supported by the AI provider.

        '
      items:
        $ref: '#/components/schemas/AiModelAuthType'
      type: array
    aiProviderDefaultBaseUrl:
      description: 'Default base URL for the AI provider.

        '
      maxLength: 1024
      minLength: 1
      type: string
    aliasName:
      description: 'Credential store alias.

        '
      maxLength: 30
      minLength: 1
      pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
      type: string
    amazonKinesisAccessKeyId:
      description: 'Access key ID to access the Amazon Kinesis.

        Note: Despite the "Id" suffix, this value is not an OCI OCID.

        '
      maxLength: 128
      minLength: 16
      type: string
    amazonKinesisEndpoint:
      description: 'The endpoint URL of the Amazon Kinesis service.

        e.g.: ''https://kinesis.us-east-1.amazonaws.com''

        If not provided, GoldenGate will default to ''https://kinesis.<region>.amazonaws.com''.

        '
      maxLength: 255
      minLength: 0
      type: string
    amazonKinesisRegion:
      description: 'The name of the AWS region.

        If not provided, GoldenGate will default to ''us-west-1''.

        Note: this property will become mandatory after July 30, 2026.

        '
      maxLength: 100
      minLength: 0
      type: string
    amazonKinesisSecretAccessKey:
      description: 'Secret access key to access the Amazon Kinesis.

        Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    amazonKinesisSecretAccessKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the secret access key is stored.

        Note: When provided, ''secretAccessKey'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    amazonKinesisTechnologyType:
      description: The Amazon Kinesis technology type.
      type: string
      x-obmcs-enumref: '#/definitions/AmazonKinesisConnection/technologyType'
    amazonRedshiftConnectionUrl:
      description: 'Connection URL.

        e.g.: ''jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb''

        '
      maxLength: 2000
      minLength: 1
      type: string
    amazonRedshiftTechnologyType:
      description: The Amazon Redshift technology type.
      type: string
      x-obmcs-enumref: '#/definitions/AmazonRedshiftConnection/technologyType'
    amazonS3AccessKeyId:
      description: 'Access key ID to access the Amazon S3 bucket.

        Note: Despite the "Id" suffix, this value is not an OCI OCID.

        '
      maxLength: 128
      minLength: 16
      type: string
    amazonS3Endpoint:
      description: 'The Amazon Endpoint for S3.

        e.g.: ''https://my-bucket.s3.us-east-1.amazonaws.com''

        If not provided, GoldenGate will default to ''https://s3.<region>.amazonaws.com''.

        '
      maxLength: 255
      minLength: 0
      type: string
    amazonS3SchemeType:
      description: 'The scheme of the storage.

        '
      type: string
      x-obmcs-enumref: '#/definitions/AmazonS3IcebergStorage/schemeType'
    amazonS3TechnologyType:
      description: The Amazon S3 technology type.
      type: string
      x-obmcs-enumref: '#/definitions/AmazonS3Connection/technologyType'
    amazonS3region:
      description: 'The name of the AWS region where the bucket is created.

        If not provided, GoldenGate will default to ''us-west-2''.

        Note: this property will become mandatory after May 20, 2026.

        '
      maxLength: 100
      minLength: 0
      type: string
    amazonSecretAccessKey:
      description: 'Secret access key to access the Amazon S3 bucket.


        Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    amazonSecretAccessKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.

        Note: When provided, ''secretAccessKey'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    availabilityDomain:
      description: The availability domain of a placement.
      maxLength: 255
      minLength: 0
      type: string
    azureAuthorityHost:
      description: 'The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory).

        Default value: https://login.microsoftonline.com

        When connecting to a non-public Azure Cloud, the endpoint must be provided, eg:

        * Azure China: https://login.chinacloudapi.cn/

        * Azure US Government: https://login.microsoftonline.us/

        '
      maxLength: 2000
      minLength: 0
      type: string
    azureDataLakeStorageAccountKey:
      description: 'Azure storage account key. This property is required when ''authenticationType'' is set to ''SHARED_KEY''.

        e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ==

        Deprecated: This field is deprecated and replaced by "accountKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    azureDataLakeStorageAccountKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.

        Note: When provided, ''accountKey'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    azureDataLakeStorageAccountName:
      description: 'Sets the Azure storage account name.

        '
      maxLength: 255
      minLength: 1
      type: string
    azureDataLakeStorageAuthType:
      description: 'Used authentication mechanism to access Azure Data Lake Storage.

        '
      type: string
      x-obmcs-enumref: '#/definitions/AzureDataLakeStorageConnection/authenticationType'
    azureDataLakeStorageClientId:
      description: 'Azure client ID of the application. This property is required when ''authenticationType'' is set to ''AZURE_ACTIVE_DIRECTORY''.

        e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

        '
      maxLength: 255
      minLength: 1
      type: string
    azureDataLakeStorageClientSecret:
      description: 'Azure client secret (aka application password) for authentication. This property is required when ''authenticationType'' is set to ''AZURE_ACTIVE_DIRECTORY''.

        e.g.: dO29Q~F5-VwnA.lZdd11xFF_t5NAXCaGwDl9NbT1

        Deprecated: This field is deprecated and replaced by "clientSecretSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    azureDataLakeStorageClientSecretSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.

        Note: When provided, ''clientSecret'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    azureDataLakeStorageEndpoint:
      description: 'Azure Storage service endpoint.

        e.g: https://test.blob.core.windows.net

        '
      maxLength: 2000
      minLength: 0
      type: string
    azureDataLakeStorageSasToken:
      description: 'Credential that uses a shared access signature (SAS) to authenticate to an Azure Service. This property is

        required when ''authenticationType'' is set to ''SHARED_ACCESS_SIGNATURE''.

        e.g.: ?sv=2020-06-08&ss=bfqt&srt=sco&sp=rwdlacupyx&se=2020-09-10T20:27:28Z&st=2022-08-05T12:27:28Z&spr=https&sig=C1IgHsiLBmTSStYkXXGLTP8it0xBrArcgCqOsZbXwIQ%3D

        Deprecated: This field is deprecated and replaced by "sasTokenSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 2000
      minLength: 0
      type: string
    azureDataLakeStorageSasTokenSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored.

        Note: When provided, ''sasToken'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    azureDataLakeStorageTechnologyType:
      description: The Azure Data Lake Storage technology type.
      type: string
      x-obmcs-enumref: '#/definitions/AzureDataLakeStorageConnection/technologyType'
    azureDataLakeStorageTenantId:
      description: 'Azure tenant ID of the application. This property is required when ''authenticationType'' is set to ''AZURE_ACTIVE_DIRECTORY''.

        e.g.: 14593954-d337-4a61-a364-9f758c64f97f

        '
      maxLength: 255
      minLength: 1
      type: string
    azureSynapseConnectionString:
      description: 'JDBC connection string.

        e.g.: ''jdbc:sqlserver://<synapse-workspace>.sql.azuresynapse.net:1433;database=<db-name>;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;''

        '
      maxLength: 2000
      minLength: 1
      type: string
    azureSynapseTechnologyType:
      description: The Azure Synapse Analytics technology type.
      type: string
      x-obmcs-enumref: '#/definitions/AzureSynapseConnection/technologyType'
    backupSourceType:
      description: 'Possible deployment backup source types.

        '
      enum:
      - MANUAL
      - AUTOMATIC
      - SCHEDULED
      type: string
    bucketName:
      description: Name of the bucket where the object is to be uploaded in the object storage
      type: string
    bundleReleaseUpgradePeriodInDays:
      description: 'Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases.

        This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.

        '
      minimum: 0
      type: integer
    byolCpuCoreCountLimit:
      description: 'The maximum number of CPUs allowed with a ''Bring Your Own License'' (BYOL) license type.

        Any CPU usage above this limit is considered as License Included and billed.

        '
      minimum: 1
      type: integer
    cancelDeploymentBackupType:
      description: 'The type of a deployment backup cancel

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/CancelDeploymentBackupType'
    cancelDeploymentUpgradeType:
      description: 'The type of a deploymentUpgrade cancel.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/CancelDeploymentUpgradeType'
    cancelSnoozeDeploymentUpgradeType:
      description: 'The type of a deploymentUpgrade cancel snooze.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/CancelSnoozeDeploymentUpgradeType'
    certificateAuthorityKeyId:
      description: 'The Certificate authority key id.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateContent:
      description: 'The base64 encoded content of the PEM file containing the SSL certificate.

        '
      maxLength: 65536
      minLength: 0
      type: string
    certificateIssuer:
      description: 'The Certificate issuer.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateKey:
      description: "The identifier key (unique name in the scope of the deployment) of the certificate being referenced. \nIt must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.\n"
      maxLength: 32
      minLength: 1
      type: string
    certificateLifecycleState:
      description: 'Possible certificate lifecycle states.

        '
      enum:
      - CREATING
      - ACTIVE
      - DELETING
      - DELETED
      - FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/CertificateLifecycleState'
    certificateMd5Hash:
      description: 'The Certificate md5Hash.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificatePublicKey:
      description: 'The Certificate public key.

        '
      maxLength: 51200
      minLength: 0
      type: string
    certificatePublicKeyAlgorithm:
      description: 'The Certificate public key algorithm.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificatePublicKeySize:
      description: 'The Certificate public key size.

        '
      format: int64
      type: integer
    certificateSerial:
      description: 'The Certificate serial.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateSha1Hash:
      description: 'The Certificate sha1 hash.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateSubject:
      description: 'The Certificate subject.

        '
      example: 'C=AA,O=AAAA,OU=AAAA,CN=AAAA

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateSubjectKeyId:
      description: 'The Certificate subject key id.

        '
      maxLength: 255
      minLength: 0
      type: string
    certificateVersion:
      description: 'The Certificate version.

        '
      maxLength: 255
      minLength: 0
      type: string
    clonePipelineType:
      description: 'Type of a pipeline clone. This option applies when cloning a pipeline.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/ClonePipelineType'
    clusterPlacementGroupId:
      description: 'The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.

        Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud

        subscription id is provided. Otherwise the cluster placement group must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    code:
      description: 'The code returned when GoldenGate reports an error while running a step during pipeline initialization.

        https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2

        '
      type: string
    compartmentId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    connectionAssignmentId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection assignment being

        referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    connectionAssignmentLifecycleState:
      description: Possible lifecycle states for connection assignments.
      type: string
      x-obmcs-enumref: '#/definitions/ConnectionAssignment/lifecycleState'
    connectionId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

        referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    connectionKeyId:
      description: 'References the OCI Vault key in the OCI Vault identified by `vaultId`.


        Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

        corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

        attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


        The GoldenGate service uses this key to encrypt sensitive information (for example, `password`) that is provided in plain-text connection attributes through the API.

        This field is applicable only when `doesUseSecretIds` is set to `false`. If both `vaultId` and `keyId` are provided,

        the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data.

        If neither `vaultId` nor `keyId` is provided, the GoldenGate service uses Oracle-managed encryption keys.

        '
      maxLength: 255
      minLength: 0
      type: string
    connectionString:
      description: 'Connect descriptor or Easy Connect Naming method used to connect to a database.

        '
      maxLength: 2000
      minLength: 1
      type: string
    connectionSubnetId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection.

        '
      maxLength: 255
      minLength: 0
      type: string
    connectionType:
      description: 'The connection type.

        '
      enum:
      - GOLDENGATE
      - KAFKA
      - KAFKA_SCHEMA_REGISTRY
      - MYSQL
      - JAVA_MESSAGE_SERVICE
      - MICROSOFT_SQLSERVER
      - OCI_OBJECT_STORAGE
      - ORACLE
      - AZURE_DATA_LAKE_STORAGE
      - POSTGRESQL
      - AZURE_SYNAPSE_ANALYTICS
      - SNOWFLAKE
      - AMAZON_S3
      - HDFS
      - ORACLE_AI_DATA_PLATFORM
      - ORACLE_NOSQL
      - MONGODB
      - AMAZON_KINESIS
      - AMAZON_REDSHIFT
      - DB2
      - REDIS
      - ELASTICSEARCH
      - GENERIC
      - GOOGLE_CLOUD_STORAGE
      - GOOGLE_BIGQUERY
      - DATABRICKS
      - GOOGLE_PUBSUB
      - MICROSOFT_FABRIC
      - ICEBERG
      - AI_MODEL
      type: string
      x-obmcs-top-level-enum: '#/definitions/ConnectionType'
    connectionTypes:
      description: 'An array of connectionTypes.

        '
      items:
        enum:
        - GOLDENGATE
        - KAFKA
        - KAFKA_SCHEMA_REGISTRY
        - MYSQL
        - JAVA_MESSAGE_SERVICE
        - MICROSOFT_SQLSERVER
        - OCI_OBJECT_STORAGE
        - ORACLE
        - AZURE_DATA_LAKE_STORAGE
        - POSTGRESQL
        - AZURE_SYNAPSE_ANALYTICS
        - SNOWFLAKE
        - AMAZON_S3
        - HDFS
        - ORACLE_AI_DATA_PLATFORM
        - ORACLE_NOSQL
        - MONGODB
        - AMAZON_KINESIS
        - AMAZON_REDSHIFT
        - DB2
        - REDIS
        - ELASTICSEARCH
        - GENERIC
        - GOOGLE_CLOUD_STORAGE
        - GOOGLE_BIGQUERY
        - DATABRICKS
        - GOOGLE_PUBSUB
        - MICROSOFT_FABRIC
        - ICEBERG
        - AI_MODEL
        type: string
        x-obmcs-top-level-enum: '#/definitions/ConnectionType'
      type: array
    connectionUrl:
      description: 'Connection URL.

        It must start with ''jdbc:spark://''

        '
      maxLength: 255
      minLength: 1
      type: string
    connectionVaultId:
      description: 'References the OCI Vault that contains the customer-managed encryption key identified by `keyId`.


        Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the

        corresponding Secret OCID attributes of the connection (for example, `passwordSecretId`) instead of plain-text

        attributes encrypted with `vaultId` and `keyId`. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


        This field is applicable only when `doesUseSecretIds` is set to `false`.

        If `vaultId` is provided, `keyId` must also be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    consumers:
      description: 'array of consumer process names

        '
      items:
        maxLength: 32
        minLength: 0
        type: string
      type: array
    correctiveAction:
      description: 'The corrective action for non-passing checks. Null for passed checks.

        '
      type: string
    cpuCoreCount:
      description: 'The Minimum number of OCPUs to be made available for this Deployment.

        '
      maximum: 24
      minimum: 1
      type: integer
    createKafkaBootstrapServers:
      description: 'Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:

        list of KafkaBootstrapServer objects specified by host/port.

        Used for establishing the initial connection to the Kafka cluster.

        Example: `"server1.example.com:9092,server2.example.com:9092"`

        '
      items:
        $ref: '#/components/schemas/CreateKafkaBootstrapServer'
      type: array
    credentialStore:
      default: GOLDENGATE
      description: 'The type of credential store for OGG.

        '
      enum:
      - GOLDENGATE
      - IAM
      type: string
      x-obmcs-top-level-enum: '#/definitions/CredentialStore'
    databaseId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    databaseName:
      description: 'The name of the database.

        '
      maxLength: 255
      minLength: 1
      type: string
    databaseRegId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the databaseRegistration being

        referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    databricksAuthType:
      description: 'Used authentication mechanism to access Databricks.

        '
      type: string
      x-obmcs-enumref: '#/definitions/DatabricksConnection/authenticationType'
    databricksClientId:
      description: 'OAuth client id, only applicable for authenticationType == OAUTH_M2M

        '
      maxLength: 255
      minLength: 1
      type: string
    databricksClientSecret:
      description: 'OAuth client secret, only applicable for authenticationType == OAUTH_M2M

        Deprecated: This field is deprecated and replaced by "clientSecretSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    databricksClientSecretSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.

        Only applicable for authenticationType == OAUTH_M2M.

        Note: When provided, ''clientSecret'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    databricksConnectionUrl:
      description: 'Connection URL.

        e.g.: ''jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb''

        '
      maxLength: 2000
      minLength: 1
      type: string
    databricksPassword:
      description: 'The password used to connect to Databricks.

        Only applicable for authenticationType == PERSONAL_ACCESS_TOKEN.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    databricksPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    databricksStorageCredentialName:
      description: 'Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

        '
      maxLength: 255
      minLength: 0
      type: string
    databricksTechnologyType:
      description: The Databricks technology type.
      type: string
      x-obmcs-enumref: '#/definitions/DatabricksConnection/technologyType'
    day:
      description: 'Days of the week.

        '
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      type: string
      x-obmcs-top-level-enum: '#/definitions/Day'
    db2Password:
      description: 'The password Oracle GoldenGate uses to connect the associated DB2 database.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    db2PasswordSecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored, \nthat Oracle GoldenGate uses to connect the associated DB2 database.\nNote: When provided, 'password' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
    db2SecurityProtocol:
      description: Security protocol for the DB2 database.
      type: string
      x-obmcs-enumref: '#/definitions/Db2Connection/securityProtocol'
    db2SslClientKeystash:
      description: 'The base64 encoded keystash file which contains the encrypted password to the key database file.

        This property is not supported for IBM Db2 for i, as client TLS mode is not available.


        Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    db2SslClientKeystashSecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored, \nwhich contains the encrypted password to the key database file.\nThis property is not supported for IBM Db2 for i, as client TLS mode is not available.\n\nNote: When provided, 'sslClientKeystash' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
    db2SslClientKeystoredb:
      description: 'The base64 encoded keystore file created at the client containing the server certificate / CA root certificate.

        This property is not supported for IBM Db2 for i, as client TLS mode is not available.


        Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    db2SslClientKeystoredbSecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored, \nwhich created at the client containing the server certificate / CA root certificate.\nThis property is not supported for IBM Db2 for i, as client TLS mode is not available.\n\nNote: When provided, 'sslClientKeystoredb' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
    db2SslServerCertificate:
      description: 'The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    db2TechnologyType:
      description: The DB2 technology type.
      type: string
      x-obmcs-enumref: '#/definitions/Db2Connection/technologyType'
    db2Username:
      description: 'The username Oracle GoldenGate uses to connect to the DB2 database.

        This username must already exist and be available by the DB2 to be connected to.

        '
      maxLength: 255
      minLength: 1
      type: string
    dbRegConnectionId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the connection being

        referenced as the successor resource of the deprecated database registration.

        '
      maxLength: 255
      minLength: 0
      type: string
    dbSystemId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database system being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    defaultCpuCoreCount:
      description: 'The default CPU core count.

        '
      maximum: 24
      minimum: 1
      type: integer
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer, and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Tags defined for this resource. Each key is predefined and scoped to a namespace.


        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
      x-default-description: 'null'
    deploymentBackupId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the backup being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentBackupType:
      description: 'Possible Deployment backup types.

        '
      enum:
      - INCREMENTAL
      - FULL
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentBackupType'
    deploymentCategory:
      description: 'The deployment category defines the broad separation of the deployment type into four categories.

        Currently the separation is ''DATA_REPLICATION'', ''STREAM_ANALYTICS'', ''DATA_TRANSFORMS'' and ''DATA_VERIFICATION''.

        '
      enum:
      - DATA_REPLICATION
      - STREAM_ANALYTICS
      - DATA_TRANSFORMS
      - DATA_VERIFICATION
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentCategory'
    deploymentDefaultUsername:
      description: 'The default admin username used by deployment.

        '
      type: string
    deploymentDiagnosticState:
      description: 'The state of the deployment diagnostic collection.

        '
      enum:
      - IN_PROGRESS
      - SUCCEEDED
      - FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentDiagnosticState'
    deploymentId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentMessage:
      description: 'The deployment Message in plain text with optional HTML anchor tags.

        '
      maxLength: 255
      minLength: 0
      type: string
    deploymentMessageId:
      description: 'The deployment Message Id.

        '
      maxLength: 255
      minLength: 0
      type: string
    deploymentMessageStatus:
      description: 'The deployment Message Status.

        '
      enum:
      - INFO
      - WARNING
      - ERROR
      type: string
    deploymentPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored.

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentPeerType:
      description: 'The type of the deployment peer.

        '
      enum:
      - LOCAL
      - REMOTE
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentPeerType'
    deploymentPlacementDetailsList:
      description: 'An array of local peers of deployment

        '
      items:
        $ref: '#/components/schemas/DeploymentPlacementDetails'
      type: array
    deploymentPlacementInfoList:
      description: 'An array of local peers of deployment

        '
      items:
        $ref: '#/components/schemas/DeploymentPlacementInfo'
      type: array
    deploymentRole:
      description: 'The type of the deployment role.

        '
      enum:
      - PRIMARY
      - STANDBY
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentRole'
    deploymentSubnetId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the deployment''s private endpoint.

        The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025,

        after which the private subnet will be enforced.

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentType:
      description: "The type of deployment, which can be any one of the Allowed values. \nNOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. \n    Its use is discouraged in favor of 'DATABASE_ORACLE'.\n"
      enum:
      - OGG
      - DATABASE_ORACLE
      - BIGDATA
      - DATABASE_MICROSOFT_SQLSERVER
      - DATABASE_MYSQL
      - DATABASE_POSTGRESQL
      - DATABASE_DB2ZOS
      - DATABASE_DB2I
      - GGSA
      - DATA_TRANSFORMS
      - VERIDATA_SERVER
      - VERIDATA_AGENT
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentType'
    deploymentUpgradeId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deployment upgrade being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentUpgradeType:
      description: 'The type of the deployment upgrade: MANUAL or AUTOMATIC

        '
      enum:
      - MANUAL
      - AUTOMATIC
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentUpgradeType'
    deploymentWalletOperationId:
      description: 'The UUID of the wallet operation performed by the customer.

        If provided, this will reference a key which the customer can use to query or search a particular wallet operation

        '
      maxLength: 255
      minLength: 1
      type: string
    deploymentWalletOperationStatus:
      description: 'The status of the deployment wallet.

        '
      enum:
      - EXPORTING
      - EXPORTED
      - IMPORTED
      - IMPORTING
      - FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentWalletStatus'
    deploymentWalletOperationType:
      description: 'The operation type of the deployment wallet.

        '
      enum:
      - EXPORT
      - IMPORT
      type: string
      x-obmcs-top-level-enum: '#/definitions/DeploymentWalletOperationType'
    description:
      description: 'Metadata about this specific object.

        '
      maxLength: 400
      minLength: 0
      type: string
      x-default-description: 'null'
    diagnosticName:
      description: Name of the diagnostic collected and uploaded to object storage
      type: string
    diagnosticPrefixName:
      description: Prefix of the diagnostic collected and uploaded to object storage
      maxLength: 128
      minLength: 1
      pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
      type: string
    disasterRecoveryStatus:
      description: 'Indicates if disaster recovery is enabled for a deployment.

        If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.

        '
      enum:
      - ENABLED
      - DISABLED
      type: string
      x-obmcs-top-level-enum: '#/definitions/DisasterRecoveryStatus'
    displayName:
      description: 'An object''s Display Name.

        '
      maxLength: 255
      minLength: 1
      type: string
    doesUseSecretIds:
      default: false
      description: 'Indicates that sensitive attributes are provided via Secrets.


        Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID

        attributes of the connection (for example, `passwordSecretId`) instead of plain-text attributes. This change follows

        the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate


        When set to `true`, all sensitive information must be provided as OCI Vault secrets using the corresponding

        `*SecretId` attributes of the connection (for example, `passwordSecretId`). Plain-text sensitive attributes (for example, `password`) must not be used.

        This ensures that sensitive information remains stored and managed in the customer''s OCI Vault rather than by the GoldenGate service.


        When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, `password`) rather than in secret OCID attributes.

        In this mode, the sensitive information is stored by the GoldenGate service. If `vaultId` and `keyId` are not specified,

        the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.


        If `vaultId` and `keyId` are provided, the specified customer-managed key is used.

        '
      type: boolean
    elasticsearchAuthenticationType:
      description: Authentication type for Elasticsearch.
      type: string
      x-obmcs-enumref: '#/definitions/ElasticsearchConnection/AuthenticationType'
    elasticsearchFingerprint:
      description: 'Fingerprint required by TLS security protocol.

        Eg.: ''6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c''

        '
      maxLength: 1000
      minLength: 0
      type: string
    elasticsearchSecurityProtocol:
      description: Security protocol for Elasticsearch.
      type: string
      x-obmcs-enumref: '#/definitions/ElasticsearchConnection/SecurityProtocol'
    elasticsearchServers:
      description: "Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. \nIf port is not specified, it defaults to 9200.\nUsed for establishing the initial connection to the Elasticsearch cluster.\nExample: `\"server1.example.com:4000,server2.example.com:4000\"`\n"
      maxLength: 5000
      minLength: 1
      type: string
    elasticsearchTechnologyType:
      description: The Elasticsearch technology type.
      type: string
      x-obmcs-enumref: '#/definitions/ElasticsearchConnection/technologyType'
    environmentType:
      description: 'Specifies whether the deployment is used in a production or development/testing environment.

        '
      enum:
      - PRODUCTION
      - DEVELOPMENT_OR_TESTING
      type: string
      x-obmcs-top-level-enum: '#/definitions/EnvironmentType'
    errors:
      description: 'List of test connection assignment error objects.

        '
      items:
        $ref: '#/components/schemas/TestConnectionAssignmentError'
      type: array
    faultDomain:
      description: The fault domain of a placement.
      maxLength: 255
      minLength: 0
      type: string
    fqdn:
      description: 'A three-label Fully Qualified Domain Name (FQDN) for a resource.

        '
      type: string
    freeformTags:
      additionalProperties:
        type: string
      description: 'A simple key-value pair that is applied without any predefined name, type, or scope. Exists

        for cross-compatibility only.


        Example: `{"bar-key": "value"}`

        '
      type: object
      x-default-description: 'null'
    frequencyBackupScheduled:
      description: 'The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.

        '
      enum:
      - DAILY
      - WEEKLY
      - MONTHLY
      type: string
    genericHost:
      description: 'Host and port separated by colon.

        Example: `"server.example.com:1234"`


        For multiple hosts, provide a comma separated list.

        Example: `"server1.example.com:1000,server1.example.com:2000"`

        '
      maxLength: 5000
      minLength: 1
      type: string
    genericTechnologyType:
      description: The Generic technology type.
      type: string
      x-obmcs-enumref: '#/definitions/GenericConnection/technologyType'
    goldenGatePassword:
      description: 'The password used to connect to the Oracle GoldenGate accessed trough this connection.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    goldenGatePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,

        which is used to connect to the Oracle GoldenGate accessed trough this connection.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    goldenGateTechnologyType:
      description: The GoldenGate technology type.
      type: string
      x-obmcs-enumref: '#/definitions/GoldenGateConnection/technologyType'
    goldenGateUsername:
      description: 'The username credential existing in the Oracle GoldenGate used to be connected to.

        '
      maxLength: 255
      minLength: 0
      type: string
    googleBigQueryEndpoint:
      description: 'A legal URL to connect to BigQuery including scheme, server name and port (if not the default port).

        Default: https://bigquery.googleapis.com

        '
      maxLength: 1000
      minLength: 0
      type: string
    googleBigQueryServiceAccountKeyFile:
      description: 'The base64 encoded content of the service account key file containing

        the credentials required to use Google BigQuery.

        Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    googleBigQueryServiceAccountKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,

        which contains the credentials required to use Google BigQuery.

        Note: When provided, ''serviceAccountKeyFile'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    googleBigQueryTechnologyType:
      description: The Google BigQuery technology type.
      type: string
      x-obmcs-enumref: '#/definitions/GoogleBigQueryConnection/technologyType'
    googleCloudStorageEndpoint:
      description: 'A legal URL to connect to Google Cloud Storage including scheme, server name and port (if not the default port).

        Default: https://storage.googleapis.com

        '
      maxLength: 1000
      minLength: 0
      type: string
    googleCloudStorageServiceAccountKeyFile:
      description: 'The base64 encoded content of the service account key file containing

        the credentials required to use Google Cloud Storage.

        Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    googleCloudStorageServiceAccountKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,

        which contains the credentials required to use Google Cloud Storage.

        Note: When provided, ''serviceAccountKeyFile'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    googleCloudStorageTechnologyType:
      description: The Google Cloud Storage technology type.
      type: string
      x-obmcs-enumref: '#/definitions/GoogleCloudStorageConnection/technologyType'
    googlePubSubServiceAccountKeyFile:
      description: 'The base64 encoded content of the service account key file containing

        the credentials required to use Google PubSub.

        Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    googlePubSubServiceAccountKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,

        which contains the credentials required to use Google PubSub.

        Note: When provided, ''serviceAccountKeyFile'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    googlePubSubTechnologyType:
      description: The Google PubSub technology type.
      type: string
      x-obmcs-enumref: '#/definitions/GooglePubSubConnection/technologyType'
    hdfsCoreSiteXml:
      description: 'The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml).

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 1
      type: string
    hdfsTechnologyType:
      description: The Hadoop Distributed File System technology type.
      type: string
      x-obmcs-enumref: '#/definitions/HdfsConnection/technologyType'
    host:
      description: 'The name or address of a host.

        '
      maxLength: 800
      minLength: 1
      type: string
    icebergAmazonS3AccessKeyId:
      description: 'Access key ID to access the Amazon S3 bucket.

        Note: Despite the "Id" suffix, this value is not an OCI OCID.

        '
      maxLength: 128
      minLength: 1
      type: string
    icebergAmazonS3Bucket:
      description: S3 bucket where Iceberg stores metadata and data files.
      maxLength: 255
      minLength: 1
      type: string
    icebergAmazonS3Endpoint:
      description: 'The endpoint URL of the Amazon S3 storage service.

        e.g.: ''https://s3.amazonaws.com''

        '
      maxLength: 2000
      minLength: 0
      type: string
    icebergAmazonS3Region:
      description: 'The AMAZON region where the S3 bucket is hosted.

        e.g.: ''us-east-2''

        '
      maxLength: 255
      minLength: 1
      type: string
    icebergAmazonSecretAccessKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored.

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergAwsGlueId:
      description: The AWS Glue Catalog ID where Iceberg tables are registered.
      maxLength: 255
      minLength: 1
      type: string
    icebergAzureAccountKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored.

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergAzureBlobEndpoint:
      description: 'The Azure Blob Storage endpoint where Iceberg data is stored.

        e.g.: ''https://my-azure-storage-account.blob.core.windows.net''

        '
      maxLength: 2000
      minLength: 0
      type: string
    icebergAzureContainer:
      description: The Azure Blob Storage container where Iceberg tables are stored.
      maxLength: 255
      minLength: 1
      type: string
    icebergAzureDataLakeStorageAccountName:
      description: 'Sets the Azure storage account name.

        '
      maxLength: 255
      minLength: 1
      type: string
    icebergCatalogType:
      description: 'The catalog type.

        '
      enum:
      - GLUE
      - HADOOP
      - NESSIE
      - POLARIS
      - REST
      type: string
      x-obmcs-top-level-enum: '#/definitions/IcebergCatalogType'
    icebergGoogleCloudStorageBucket:
      description: Google Cloud Storage bucket where Iceberg stores metadata and data files.
      maxLength: 255
      minLength: 1
      type: string
    icebergGoogleCloudStorageEndpoint:
      description: 'A legal URL to connect to Google Cloud Storage including scheme, server name and port (if not the default port).

        Default: https://storage.googleapis.com

        '
      maxLength: 1000
      minLength: 0
      type: string
    icebergGoogleCloudStorageProjectId:
      description: The Google Cloud Project where the bucket exists.
      maxLength: 255
      minLength: 1
      type: string
    icebergGoogleCloudStorageServiceAccountKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored,

        which contains the credentials required to use Google Cloud Storage.

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergNessieBranch:
      description: The active branch of the Nessie catalog from which Iceberg reads and writes table metadata.
      maxLength: 255
      minLength: 1
      type: string
    icebergNessieUri:
      description: 'Nessie URI.

        e.g.: ''http://<nessie-server>.com:10001/api/v2''

        '
      maxLength: 2000
      minLength: 1
      type: string
    icebergObjectStorageEndpoint:
      description: 'OCI Object Storage S3 Compatibility API endpoint URL.

        Format: "https://<namespace>.compat.objectstorage.<region>.<domain>"

        Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"

        '
      maxLength: 2000
      minLength: 0
      type: string
    icebergOciObjectStorageAccessKeyId:
      description: 'Access Key ID from the OCI IAM user''s Customer Secret Key pair used to authenticate to

        OCI Object Storage via the S3 Compatibility API.


        Note: Despite the "Id" suffix, this value is not an OCI OCID.

        '
      maxLength: 128
      minLength: 1
      type: string
    icebergOciObjectStorageBucket:
      description: 'Target OCI Object Storage bucket name where Iceberg stores

        table metadata and data files.

        '
      maxLength: 255
      minLength: 1
      type: string
    icebergOciObjectStorageRegion:
      description: 'The OCI region where the OCI Object Storage bucket is hosted.

        The region identifier used for request signing and routing when accessing

        the Object Storage service via S3-compatible APIs.


        This parameter is optional. If not provided, the service will attempt to

        infer the region from the endpoint URL.


        If provided, the value must match the region encoded in the endpoint.

        In case of mismatch, the request should be rejected.

        e.g.: ''us-east-2''

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergOciObjectStorageSecretAccessKey:
      description: 'Secret Access Key from the OCI IAM user''s Customer Secret Key pair used to authenticate to

        OCI Object Storage via the S3 Compatibility API.

        Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    icebergOciObjectStorageSecretAccessKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key used for OCI Object Storage S3 Compatibility authentication.

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergPolarisCatalogName:
      description: The catalog name within Polaris where Iceberg tables are registered.
      maxLength: 255
      minLength: 1
      type: string
    icebergPolarisCatalogUri:
      description: 'The URL endpoint for the Polaris API.

        e.g.: ''https://<your-snowflake-account>.snowflakecomputing.com/polaris/api/catalog''

        '
      maxLength: 2000
      minLength: 1
      type: string
    icebergPolarisClientId:
      description: The OAuth client ID used for authentication.
      maxLength: 255
      minLength: 1
      type: string
    icebergPolarisClientSecret:
      description: 'Client secret required to connect to Polaris.

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    icebergPolarisClientSecretSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergPolarisPrincipalRole:
      description: The Snowflake role used to access Polaris.
      maxLength: 255
      minLength: 1
      type: string
    icebergRestCatalogProperties:
      description: 'The base64 encoded content of the configuration file containing additional properties for the REST catalog.

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    icebergRestCatalogPropertiesSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content

        of the configuration file containing additional properties for the REST catalog.

        See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

        '
      maxLength: 255
      minLength: 0
      type: string
    icebergRestCatalogUri:
      description: 'The base URL for the REST Catalog API.

        e.g.: ''https://my-rest-catalog.example.com/api/v1''

        '
      maxLength: 2000
      minLength: 1
      type: string
    icebergStorageType:
      description: 'The storage type used in the Iceberg connection.

        '
      enum:
      - AMAZON_S3
      - GOOGLE_CLOUD_STORAGE
      - AZURE_DATA_LAKE_STORAGE
      - NONE
      - OCI_OBJECT_STORAGE_S3_API
      type: string
      x-obmcs-top-level-enum: '#/definitions/IcebergStorageType'
    icebergTechnologyType:
      description: 'The Iceberg technology type.

        '
      type: string
      x-obmcs-enumref: '#/definitions/IcebergConnection/technologyType'
    identityDomainId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used.

        '
      maxLength: 255
      minLength: 1
      type: string
    ingressIp:
      description: 'A Private Endpoint IPv4 or IPv6 Address created in the customer''s subnet.

        '
      maxLength: 46
      minLength: 1
      type: string
    ingressIps:
      description: "List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. \nCustomers may optionally set up ingress security rules to restrict traffic from these IP addresses.\n"
      items:
        $ref: '#/components/schemas/IngressIpDetails'
      type: array
      x-default-description: 'null'
    interimReleaseUpgradePeriodInDays:
      description: 'Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.

        '
      minimum: 0
      type: integer
    ipAddress:
      description: 'The private IP address in the customer''s VCN of the customer''s endpoint, typically a

        database.

        '
      maxLength: 46
      minLength: 0
      type: string
    isAutoScalingEnabled:
      description: 'Indicates if auto scaling is enabled for the Deployment''s CPU core count.

        '
      type: boolean
    isAutoScalingEnabledByDefault:
      description: 'Specifies whether the "Auto scaling" option should be enabled by default or not.

        '
      type: boolean
    isAutomatic:
      description: 'True if this object is automatically created

        '
      type: boolean
      x-default-description: false
    isByolCpuCoreCountLimitEnabled:
      default: false
      description: 'Flag to allow to configure the ''Bring Your Own License'' (BYOL) license type CPU limit.

        If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

        '
      type: boolean
    isCancelAllowed:
      description: "Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service, \notherwise only reschedule allowed.\n"
      type: boolean
    isCertificateCa:
      description: 'Indicates if the certificate is ca.

        '
      type: boolean
    isHealthy:
      description: 'True if all of the aggregate resources are working correctly.

        '
      type: boolean
    isInterimReleaseAutoUpgradeEnabled:
      description: "By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, \nyou have to specify interimReleaseUpgradePeriodInDays too.\n"
      type: boolean
    isLatestVersion:
      description: 'Indicates if the resource is the the latest available version.

        '
      type: boolean
    isMetadataOnly:
      default: false
      description: Parameter to allow users to create backup without trails
      type: boolean
    isOggWalletExists:
      description: Indicates if the wallet is present in the deployment container
      type: boolean
    isPublic:
      description: 'True if this object is publicly available.

        '
      type: boolean
      x-default-description: false
    isRescheduleAllowed:
      description: 'Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period.

        '
      type: boolean
    isRollbackAllowed:
      description: 'Indicates if rollback is allowed. In practice only the last upgrade can be rolled back.

        - Manual upgrade is allowed to rollback only until the old version isn''t deprecated yet.

        - Automatic upgrade by default is not allowed, unless a serious issue does not justify.

        '
      type: boolean
    isSecurityFix:
      description: 'Indicates if OGG release contains security fix.

        '
      type: boolean
    isSelfSigned:
      description: 'Indicates if the certificate is self signed.

        '
      type: boolean
    isSnoozed:
      description: 'Indicates if upgrade notifications are snoozed or not.

        '
      type: boolean
    isStorageUtilizationLimitExceeded:
      description: 'Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.

        Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit.  Exceeding the limit may be an indication of a misconfiguration of the deployment''s GoldenGate service.

        '
      type: boolean
      x-default-description: false
    jmsAuthenticationType:
      description: 'Authentication type for Java Message Service.  If not provided, default is NONE.

        Optional until 2024-06-27, in the release after it will be made required.

        '
      type: string
      x-obmcs-enumref: '#/definitions/JavaMessageServiceConnection/AuthenticationType'
    jmsConnectionFactoryClassName:
      description: 'The of Java class implementing javax.jms.ConnectionFactory interface

        supplied by the Java Message Service provider.

        e.g.: ''com.stc.jmsjca.core.JConnectionFactoryXA''

        '
      maxLength: 200
      minLength: 0
      type: string
    jmsConnectionUrl:
      description: 'Connection URL of the Java Message Service, specifying the protocol, host, and port.

        e.g.: ''mq://myjms.host.domain:7676''

        '
      maxLength: 2000
      minLength: 0
      type: string
    jmsJndiConnectionFactoryName:
      description: 'The Connection Factory can be looked up using this name.

        e.g.: ''ConnectionFactory''

        '
      maxLength: 200
      minLength: 0
      type: string
    jmsJndiInitialConnectionFactoryClassName:
      description: 'The implementation of javax.naming.spi.InitialContextFactory interface

        that the client uses to obtain initial naming context.

        e.g.: ''org.apache.activemq.jndi.ActiveMQInitialContextFactory''

        '
      maxLength: 200
      minLength: 0
      type: string
    jmsJndiProviderUrl:
      description: 'The URL that Java Message Service will use to contact the JNDI provider.

        e.g.: ''tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000''

        '
      maxLength: 2000
      minLength: 0
      type: string
    jmsJndiSecurityCredentials:
      description: 'The password associated to the principal.

        Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 200
      minLength: 0
      type: string
    jmsJndiSecurityCredentialsSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal.

        Note: When provided, ''jndiSecurityCredentials'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsJndiSecurityPrincipal:
      description: 'Specifies the identity of the principal (user) to be authenticated.

        e.g.: ''admin2''

        '
      maxLength: 200
      minLength: 0
      type: string
    jmsKeyStore:
      description: 'The base64 encoded content of the KeyStore file.

        Deprecated: This field is deprecated and replaced by "keyStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    jmsKeyStorePassword:
      description: 'The KeyStore password.

        Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    jmsKeyStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored.

        Note: When provided, ''keyStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsKeyStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.

        Note: When provided, ''keyStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsPassword:
      description: 'The password Oracle GoldenGate uses to connect the associated Java Message Service.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    jmsPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored,

        that Oracle GoldenGate uses to connect the associated Java Message Service.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsSecurityProtocol:
      description: 'Security protocol for Java Message Service. If not provided, default is PLAIN.

        Optional until 2024-06-27, in the release after it will be made required.

        '
      type: string
      x-obmcs-enumref: '#/definitions/JavaMessageServiceConnection/SecurityProtocol'
    jmsSslKeyPassword:
      description: 'The password for the cert inside of the KeyStore.

        In case it differs from the KeyStore password, it should be provided.

        Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    jmsSslKeyPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore.

        In case it differs from the KeyStore password, it should be provided.

        Note: When provided, ''sslKeyPassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsTechnologyType:
      description: 'The Java Message Service technology type.

        '
      type: string
      x-obmcs-enumref: '#/definitions/JavaMessageServiceConnection/technologyType'
    jmsTrustStore:
      description: 'The base64 encoded content of the TrustStore file.

        Deprecated: This field is deprecated and replaced by "trustStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    jmsTrustStorePassword:
      description: 'The TrustStore password.

        Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    jmsTrustStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored.

        Note: When provided, ''trustStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsTrustStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.

        Note: When provided, ''trustStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    jmsUsername:
      description: 'The username Oracle GoldenGate uses to connect to the Java Message Service.

        This username must already exist and be available by the Java Message Service to be connected to.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaBootstrapServers:
      description: 'Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka:

        list of KafkaBootstrapServer objects specified by host/port.

        Used for establishing the initial connection to the Kafka cluster.

        Example: `"server1.example.com:9092,server2.example.com:9092"`

        '
      items:
        $ref: '#/components/schemas/KafkaBootstrapServer'
      type: array
    kafkaClusterId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Kafka cluster

        being referenced from OCI Streaming with Apache Kafka.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaConsumerProperties:
      description: 'The base64 encoded content of the consumer.properties file.

        '
      maxLength: 51200
      minLength: 0
      type: string
    kafkaKeyStore:
      description: 'The base64 encoded content of the KeyStore file.

        Deprecated: This field is deprecated and replaced by "keyStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    kafkaKeyStorePassword:
      description: 'The KeyStore password.

        Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    kafkaKeyStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored.

        Note: When provided, ''keyStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaKeyStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored.

        Note: When provided, ''keyStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaProducerProperties:
      description: 'The base64 encoded content of the producer.properties file.

        '
      maxLength: 51200
      minLength: 0
      type: string
    kafkaSchemaRegistryAuthType:
      description: 'Used authentication mechanism to access Schema Registry.

        '
      type: string
      x-obmcs-enumref: '#/definitions/KafkaSchemaRegistryConnection/authenticationType'
    kafkaSchemaRegistryBasicAuthPassword:
      description: 'The password to access Schema Registry using basic authentication.

        This value is injected into ''schema.registry.basic.auth.user.info=user:password'' configuration property.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistryBasicAuthPasswordSecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Kafka Schema Registry password is stored, \nThe password to access Schema Registry using basic authentication.\nThis value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.\nNote: When provided, 'password' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistryBasicAuthUsername:
      description: 'The username to access Schema Registry using basic authentication.

        This value is injected into ''schema.registry.basic.auth.user.info=user:password'' configuration property.

        '
      maxLength: 255
      minLength: 1
      type: string
    kafkaSchemaRegistrySslKeyPassword:
      description: 'The password for the cert inside the KeyStore.

        In case it differs from the KeyStore password, it should be provided.

        Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslKeyPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the cert inside the KeyStore.

        In case it differs from the KeyStore password, it should be provided.

        Note: When provided, ''sslKeyPassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslKeyStore:
      description: 'The base64 encoded content of the KeyStore file.

        Deprecated: This field is deprecated and replaced by "keyStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    kafkaSchemaRegistrySslKeyStorePassword:
      description: 'The KeyStore password.

        Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslKeyStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored.

        Note: When provided, ''keyStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslKeyStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.

        Note: When provided, ''keyStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslTrustStore:
      description: 'The base64 encoded content of the TrustStore file.

        Deprecated: This field is deprecated and replaced by "trustStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    kafkaSchemaRegistrySslTrustStorePassword:
      description: 'The TrustStore password.

        Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslTrustStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored.

        Note: When provided, ''trustStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistrySslTrustStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.

        Note: When provided, ''trustStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaSchemaRegistryTechnologyType:
      description: 'The Kafka (e.g. Confluent) Schema Registry technology type.

        '
      type: string
      x-obmcs-enumref: '#/definitions/KafkaSchemaRegistryConnection/technologyType'
    kafkaSchemaRegistryUrl:
      description: 'Kafka Schema Registry URL.

        e.g.: ''https://server1.us.oracle.com:8081''

        '
      maxLength: 2000
      minLength: 1
      type: string
    kafkaSecurityProtocol:
      description: 'Security Type for Kafka.

        '
      type: string
      x-obmcs-enumref: '#/definitions/KafkaConnection/securityProtocol'
    kafkaSslKeyPassword:
      description: 'The password for the cert inside of the KeyStore.

        In case it differs from the KeyStore password, it should be provided.

        Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    kafkaSslKeyPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored.

        Note: When provided, ''sslKeyPassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaStreamPoolId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the stream pool being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    kafkaTechnologyType:
      description: 'The Kafka technology type.

        '
      type: string
      x-obmcs-enumref: '#/definitions/KafkaConnection/technologyType'
    kafkaTrustStore:
      description: 'The base64 encoded content of the TrustStore file.

        Deprecated: This field is deprecated and replaced by "trustStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    kafkaTrustStorePassword:
      description: 'The TrustStore password.

        Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    kafkaTrustStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored.

        Note: When provided, ''trustStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    kafkaTrustStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored.

        Note: When provided, ''trustStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    key:
      description: 'UUID to uniquely identify the each check result.

        '
      maxLength: 255
      minLength: 1
      type: string
    keyId:
      description: "Refers to the customer's master key OCID. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
      maxLength: 255
      minLength: 0
      type: string
    lastRecordLagInSeconds:
      description: 'The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes.

        '
      format: float
      type: number
    libraryType:
      description: 'The type of the library URL generation.

        '
      enum:
      - LOG_READER_COMPONENT
      type: string
      x-obmcs-top-level-enum: '#/definitions/LibraryType'
    licenseModel:
      description: 'The Oracle license model that applies to a Deployment.

        '
      enum:
      - LICENSE_INCLUDED
      - BRING_YOUR_OWN_LICENSE
      type: string
      x-obmcs-top-level-enum: '#/definitions/LicenseModel'
    lifecycleDetails:
      description: 'Describes the object''s current state in detail. For example, it can be used to provide

        actionable information for a resource in a Failed state.

        '
      maxLength: 255
      minLength: 1
      type: string
    lifecycleState:
      description: 'Possible lifecycle states.

        '
      enum:
      - CREATING
      - UPDATING
      - ACTIVE
      - INACTIVE
      - DELETING
      - DELETED
      - FAILED
      - NEEDS_ATTENTION
      - IN_PROGRESS
      - CANCELING
      - CANCELED
      - SUCCEEDED
      - WAITING
      type: string
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
    lifecycleSubState:
      description: 'Possible GGS lifecycle sub-states.

        '
      enum:
      - RECOVERING
      - STARTING
      - STOPPING
      - MOVING
      - UPGRADING
      - RESTORING
      - BACKUP_IN_PROGRESS
      - ROLLBACK_IN_PROGRESS
      type: string
      x-obmcs-top-level-enum: '#/definitions/LifecycleSubState'
    loadBalancerId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer''s subnet.

        The loadbalancer of the public deployment created in the customer subnet.

        '
      maxLength: 255
      minLength: 1
      type: string
    loadBalancerSubnetId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.\n\nRules:\n- Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.\n- Update:\n  - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).\n  - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.\n\nValidation:\n- Must reference a public subnet.\n- Must be a regional subnet.\n- Must be in the same VCN as subnetId.\n"
      maxLength: 255
      minLength: 0
      type: string
    location:
      description: 'Returns the location where the object may be stored, for example, a File Path, Object

        Storage reference, and so on.

        '
      minLength: 1
      type: string
      x-default-description: 'null'
    majorReleaseUpgradePeriodInDays:
      description: 'Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases.

        Not passing this field during create will equate to using the service default.

        '
      minimum: 0
      type: integer
    mappingType:
      description: 'Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline.

        '
      enum:
      - INCLUDE
      - EXCLUDE
      type: string
      x-obmcs-top-level-enum: '#/definitions/MappingType'
    maxCpuCoreCount:
      description: 'The maximum CPU core count.

        '
      maximum: 24
      minimum: 1
      type: integer
    maxSequenceNumber:
      description: 'Maximum sequence number

        '
      maxLength: 12
      minLength: 0
      type: string
    memoryPerOcpuInGBs:
      description: 'The multiplier value between CPU core count and memory size.

        '
      minimum: 1
      type: integer
    message:
      description: 'The status message of the steps in a recipe during pipeline initialization.

        https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

        '
      type: string
    microsoftFabricAzureClientId:
      description: 'Azure client ID of the application.

        e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d

        '
      maxLength: 36
      minLength: 1
      type: string
    microsoftFabricAzureTenantId:
      description: 'Azure tenant ID of the application.

        e.g.: 14593954-d337-4a61-a364-9f758c64f97f

        '
      maxLength: 36
      minLength: 1
      type: string
    microsoftFabricClientSecret:
      description: 'Client secret associated with the client id.

        Deprecated: This field is deprecated and replaced by "clientSecretSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    microsoftFabricClientSecretSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored.

        Note: When provided, ''clientSecret'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    microsoftFabricEndpoint:
      description: 'Optional Microsoft Fabric service endpoint.

        Default value: https://onelake.dfs.fabric.microsoft.com

        '
      maxLength: 261
      minLength: 0
      type: string
    microsoftFabricTechnologyType:
      description: The Microsoft Fabric technology type.
      type: string
      x-obmcs-enumref: '#/definitions/MicrosoftFabricConnection/technologyType'
    migrateConnectionType:
      description: 'The type of a migrate Connection.

        '
      enum:
      - SECRET
      type: string
      x-obmcs-top-level-enum: '#/definitions/MigrateConnectionType'
    minCpuCoreCount:
      description: 'The minimum CPU core count.

        '
      maximum: 24
      minimum: 1
      type: integer
    minSequenceNumber:
      description: 'Minimum sequence number

        '
      maxLength: 12
      minLength: 0
      type: string
    mongoDbPassword:
      description: 'The password Oracle GoldenGate uses to connect the associated database.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    mongoDbPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated database.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    mongoDbSecurityProtocol:
      description: Security Type for MongoDB.
      type: string
      x-obmcs-enumref: '#/definitions/MongoDbConnection/securityProtocol'
    mongoDbTechnologyType:
      description: The MongoDB technology type.
      type: string
      x-obmcs-enumref: '#/definitions/MongoDbConnection/technologyType'
    mongoDbTlsCaFile:
      description: 'Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 262400
      minLength: 0
      type: string
    mongoDbTlsCertificateKeyFile:
      description: 'Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).

        Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    mongoDbTlsCertificateKeyFilePassword:
      description: 'Client Certificate key file password.

        Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    mongoDbTlsCertificateKeyFilePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file.

        Note: When provided, ''tlsCertificateKeyFilePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    mongoDbTlsCertificateKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection.

        - The content of a .pem file containing the client private key (for 2-way SSL).

        Note: When provided, ''tlsCertificateKeyFile'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    mongoDbUsername:
      description: 'The username Oracle GoldenGate uses to connect to the database.

        This username must already exist and be available by the database to be connected to.

        '
      maxLength: 255
      minLength: 0
      type: string
    mssqlPassword:
      description: 'The password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    mssqlPasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect the associated Microsoft SQL Server.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    mssqlSecurityProtocol:
      description: Security Type for Microsoft SQL Server.
      type: string
      x-obmcs-enumref: '#/definitions/MicrosoftSqlserverConnection/securityProtocol'
    mssqlSslCa:
      description: 'Database Certificate - The base64 encoded content of a .pem or .crt file

        containing the server public key (for 1-way SSL).

        '
      maxLength: 65536
      minLength: 0
      type: string
    mssqlTechnologyType:
      description: The Microsoft SQL Server technology type.
      type: string
      x-obmcs-enumref: '#/definitions/MicrosoftSqlserverConnection/technologyType'
    mssqlUsername:
      description: 'The username Oracle GoldenGate uses to connect to the Microsoft SQL Server.

        This username must already exist and be available by the Microsoft SQL Server to be connected to.

        '
      maxLength: 255
      minLength: 1
      type: string
    mysqlSecurityProtocol:
      description: Security Type for MySQL.
      type: string
      x-obmcs-enumref: '#/definitions/MysqlConnection/securityProtocol'
    mysqlSslCa:
      description: 'Database Certificate - The base64 encoded content of a .pem or .crt file

        containing the server public key (for 1 and 2-way SSL).

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    mysqlSslCert:
      description: 'Client Certificate - The base64 encoded content of a .pem or .crt file

        containing the client public key (for 2-way SSL).

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    mysqlSslCrl:
      description: 'The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

        Note: This is an optional property and only applicable if TLS/MTLS option is selected.

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    mysqlSslKey:
      description: 'Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).

        Deprecated: This field is deprecated and replaced by "sslKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    mysqlSslKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key

        - The content of a .pem or .crt file containing the client private key (for 2-way SSL).

        Note: When provided, ''sslKey'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    mysqlSslMode:
      description: SSL modes for MySQL.
      type: string
      x-obmcs-enumref: '#/definitions/MysqlConnection/sslMode'
    mysqlTechnologyType:
      description: The MySQL technology type.
      type: string
      x-obmcs-enumref: '#/definitions/MysqlConnection/technologyType'
    namespaceName:
      description: Name of namespace that serves as a container for all of your buckets
      type: string
    networkBandwidthPerOcpuInGbps:
      description: 'The multiplier value between CPU core count and network bandwidth.

        '
      minimum: 1
      type: integer
    nextMaintenanceActionType:
      description: 'Type of the next maintenance.

        '
      enum:
      - UPGRADE
      type: string
      x-obmcs-top-level-enum: '#/definitions/MaintenanceActionType'
    nextMaintenanceDescription:
      description: 'Description of the next maintenance.

        '
      minLength: 1
      type: string
    nsgIds:
      description: 'An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

        '
      items:
        maxLength: 255
        minLength: 1
        type: string
      maxItems: 5
      type: array
    numberOfSequences:
      description: 'Number of sequences for a specific trail file

        '
      minimum: 0
      type: integer
    objectName:
      description: Name of the object to be uploaded to object storage
      type: string
    ociAutonomousJsonDatabaseId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database.

        '
      maxLength: 255
      minLength: 0
      type: string
    ociObjectStorageTechnologyType:
      description: The OCI Object Storage technology type.
      type: string
      x-obmcs-enumref: '#/definitions/OciObjectStorageConnection/technologyType'
    ociObjectStorageUserId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Object Storage.

        The user must have write access to the bucket they want to connect to.

        If the user is not provided, backend will default to the user who is calling the API endpoint.

        '
      maxLength: 255
      minLength: 0
      type: string
    ociStreamingShouldUseResourcePrincipal:
      description: 'Specifies that the user intends to authenticate to the instance using a resource principal.

        Applicable only for OCI Streaming connections.

        Only available from 23.9.0.0.0 GoldenGate versions.

        Note: When specified, ''username''/''password''/''passwordSecretId'' fields must not be provided.

        Default: false

        '
      type: boolean
    oggAdminPassword:
      description: 'The password associated with the GoldenGate deployment console username.

        The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric,

        and 1 special character. Special characters such as ''$'', ''^'', or ''?'' are not allowed.

        This field will be deprecated and replaced by "passwordSecretId".

        '
      example: secret-A1
      format: password
      maxLength: 30
      minLength: 1
      pattern: (?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*
      type: string
    oggAdminUsername:
      description: 'The GoldenGate deployment console username.

        '
      example: oggadmin
      maxLength: 512
      minLength: 0
      type: string
    oggDeploymentName:
      description: 'The name given to the GoldenGate service deployment.

        The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.

        '
      maxLength: 32
      minLength: 1
      pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
      type: string
    oggDeploymentNameCreate:
      description: 'The name given to the GoldenGate service deployment.

        The name must contain only alphanumeric characters and must start with a letter.

        For standby deployment the deployment name is inherited from primary.

        '
      maxLength: 32
      minLength: 0
      pattern: ^[A-Za-z][A-Za-z0-9-_.]*$
      type: string
    oggVersion:
      description: 'Version of OGG

        '
      minLength: 1
      type: string
    operatorGroupId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup.

        It allows users to perform only operational actions, like starting and stopping resources.

        Operators cannot alter the operational parameters or profiles of the MA server.

        '
      maxLength: 255
      minLength: 0
      type: string
    oracleAiDataPlatformTechnologyType:
      description: The Oracle AI Data Platform technology type.
      type: string
      x-obmcs-enumref: '#/definitions/OracleAiDataPlatformConnection/technologyType'
    oracleAutonomousDatabaseAuthenticationMode:
      description: 'Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections,

        when a databaseId is provided. The default value is MTLS.

        '
      type: string
      x-obmcs-enumref: '#/definitions/OracleConnection/authenticationMode'
    oracleNosqlTechnologyType:
      description: The Oracle NoSQL technology type.
      type: string
      x-obmcs-enumref: '#/definitions/OracleNosqlConnection/technologyType'
    oracleNosqlUserId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the OCI user who will access the Oracle NoSQL database.

        The user must have write access to the table they want to connect to.

        If the user is not provided, backend will default to the user who is calling the API endpoint.

        '
      maxLength: 255
      minLength: 0
      type: string
    oracleTechnologyType:
      description: The Oracle technology type.
      type: string
      x-obmcs-enumref: '#/definitions/OracleConnection/technologyType'
    password:
      description: 'The password Oracle GoldenGate uses to connect the associated system of the given technology.

        It must conform to the specific security requirements including length, case sensitivity, and so on.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    passwordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored.

        The password Oracle GoldenGate uses to connect the associated system of the given technology.

        It must conform to the specific security requirements including length, case sensitivity, and so on.

        If secretId is used plaintext field must not be provided.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    pausePipelineType:
      description: 'Type of a pipeline pause. This option applies when pausing a pipeline.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/PausePipelineType'
    percentComplete:
      description: 'Shows the percentage complete of each recipe step during pipeline initialization.

        '
      maximum: 100
      minimum: 0
      type: integer
    pipelineDiagnosticState:
      description: 'The state of the pipeline diagnostics collection.

        '
      enum:
      - IN_PROGRESS
      - SUCCEEDED
      - FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/PipelineDiagnosticState'
    pipelineId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline.

        '
      maxLength: 255
      minLength: 1
      type: string
    pipelineLifecycleSubState:
      description: 'Possible lifecycle substates when retrieving a pipeline.

        '
      enum:
      - STARTING
      - STOPPING
      - STOPPED
      - MOVING
      - RUNNING
      - PAUSING
      - PAUSED
      - START_FAILED
      - STOP_FAILED
      - PAUSE_FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/PipelineLifecycleSubState'
    port:
      description: 'The port of an endpoint usually specified for a connection.

        '
      maximum: 65536
      minimum: 0
      type: integer
    postgresqlDbSystemId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database system being referenced.

        '
      maxLength: 255
      minLength: 1
      type: string
    postgresqlSecurityProtocol:
      description: Security protocol for PostgreSQL.
      type: string
      x-obmcs-enumref: '#/definitions/PostgresqlConnection/securityProtocol'
    postgresqlSslCa:
      description: "The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. \nThe supported file formats are .pem and .crt.\nIt is not included in GET responses if the `view=COMPACT` query parameter is specified.\n"
      maxLength: 65536
      minLength: 0
      type: string
    postgresqlSslCert:
      description: 'The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt.

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    postgresqlSslCrl:
      description: 'The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

        It is not included in GET responses if the `view=COMPACT` query parameter is specified.

        '
      maxLength: 65536
      minLength: 0
      type: string
    postgresqlSslKey:
      description: 'The base64 encoded private key of the PostgreSQL server. The supported file formats are .pem and .crt.

        Deprecated: This field is deprecated and replaced by "sslKeySecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    postgresqlSslKeySecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt. \nNote: When provided, 'sslKey' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
    postgresqlSslMode:
      description: SSL modes for PostgreSQL.
      type: string
      x-obmcs-enumref: '#/definitions/PostgresqlConnection/sslMode'
    postgresqlTechnologyType:
      description: The PostgreSQL technology type.
      type: string
      x-obmcs-enumref: '#/definitions/PostgresqlConnection/technologyType'
    precheckStatus:
      description: Status of the DR precheck result.
      enum:
      - SUCCEEDED
      - IN_PROGRESS
      - FAILED
      - NEEDS_ATTENTION
      type: string
      x-obmcs-top-level-enum: '#/definitions/PrecheckStatus'
    privateIp:
      description: 'This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.


        For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.

        '
      maxLength: 46
      minLength: 0
      type: string
    privateIpAddress:
      description: 'The private IP address in the customer''s VCN representing the access point for the

        associated endpoint service in the GoldenGate service VCN.

        '
      maxLength: 46
      minLength: 1
      type: string
    privateKeyFile:
      description: 'The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.

        See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

        Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    privateKeyFileSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.

        See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

        Note: When provided, ''privateKeyFile'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    privateKeyPassphrase:
      description: 'The passphrase of the private key.

        Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    privateKeyPassphraseSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the passphrase of the private key.

        Note: When provided, ''privateKeyPassphrase'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    processStatus:
      description: 'The status of the Extract or Replicat process. This option applies when retrieving running processes.

        '
      enum:
      - STOPPED
      - RUNNING
      - ERROR
      type: string
      x-obmcs-top-level-enum: '#/definitions/ProcessStatusType'
    processType:
      description: 'The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes.

        '
      enum:
      - EXTRACT
      - REPLICAT
      type: string
      x-obmcs-top-level-enum: '#/definitions/ProcessType'
    producer:
      description: 'Producer Process Name if any.

        '
      maxLength: 32
      minLength: 0
      type: string
    publicIpAddress:
      description: 'The public IP address representing the access point for the Deployment.

        '
      maxLength: 46
      minLength: 1
      type: string
    publicKeyFingerprint:
      description: 'The fingerprint of the API Key of the user specified by the userId.

        See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

        '
      type: string
    rcePrivateIp:
      description: "A Private Endpoint IP address created in the customer's subnet. \nA customer database can expect network traffic initiated by GoldenGate Service from this IP address. \nIt can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. \nThe customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed.\n"
      maxLength: 46
      minLength: 1
      type: string
    recipeType:
      description: 'The type of the recipe

        '
      enum:
      - ZERO_ETL
      type: string
      x-obmcs-top-level-enum: '#/definitions/RecipeType'
    redisAuthenticationType:
      description: Authenticationentication type for the Redis database.
      type: string
      x-obmcs-enumref: '#/definitions/RedisConnection/AuthenticationType'
    redisClusterId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Redis cluster.

        '
      maxLength: 255
      minLength: 1
      type: string
    redisKeyStore:
      description: 'The base64 encoded content of the KeyStore file.

        Deprecated: This field is deprecated and replaced by "keyStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    redisKeyStorePassword:
      description: 'The KeyStore password.

        Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    redisKeyStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored.

        Note: When provided, ''keyStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    redisKeyStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the KeyStore file.

        Note: When provided, ''keyStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    redisSecurityProtocol:
      description: Security protocol for Redis.
      type: string
      x-obmcs-enumref: '#/definitions/RedisConnection/SecurityProtocol'
    redisServers:
      description: "Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. \nIf port is not specified, it defaults to 6379.\nUsed for establishing the initial connection to the Redis cluster.\nExample: `\"server1.example.com:6379,server2.example.com:6379\"`\n"
      maxLength: 5000
      minLength: 1
      type: string
    redisTechnologyType:
      description: The Redis technology type.
      type: string
      x-obmcs-enumref: '#/definitions/RedisConnection/technologyType'
    redisTrustStore:
      description: 'The base64 encoded content of the TrustStore file.

        Deprecated: This field is deprecated and replaced by "trustStoreSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    redisTrustStorePassword:
      description: 'The TrustStore password.

        Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      type: string
    redisTrustStorePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored.

        Note: When provided, ''trustStorePassword'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    redisTrustStoreSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the TrustStore file.

        Note: When provided, ''trustStore'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    ref-jmsShouldUseJndi:
      description: 'If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

        '
      type: boolean
    refreshConnectionType:
      description: 'The type of a refresh Connection external attributes.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/RefreshConnectionType'
    region:
      description: 'The name of the region. e.g.: us-ashburn-1

        If the region is not provided, backend will default to the default region.

        '
      type: string
    relatedResourceId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource related to the corresponding check.

        '
      maxLength: 255
      minLength: 1
      type: string
    relatedResourceType:
      description: 'Type of resource related to corresponding check.

        '
      enum:
      - GOLDENGATEDEPLOYMENT
      - GOLDENGATECONNECTION
      - VAULTSECRET
      type: string
      x-obmcs-top-level-enum: '#/definitions/RelatedResourceType'
    releaseType:
      description: 'The type of release.

        '
      enum:
      - MAJOR
      - BUNDLE
      - MINOR
      type: string
      x-obmcs-top-level-enum: '#/definitions/ReleaseType'
    rescheduleDeploymentUpgradeType:
      description: 'The type of a deploymentUpgrade reschedule.

        '
      enum:
      - RESCHEDULE_TO_DATE
      type: string
      x-obmcs-top-level-enum: '#/definitions/RescheduleDeploymentUpgradeType'
    restoreDeploymentType:
      description: 'The type of a deployment restore.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/RestoreDeploymentType'
    rollbackDeploymentUpgradeType:
      description: 'The type of a deploymentUpgrade rollback.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/RollbackDeploymentUpgradeType'
    routingMethod:
      description: "Controls the network traffic direction to the target:\nSHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.\nDEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.\nSHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. \n\nDeprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method.\nThis change follows the GoldenGate \"Plain Text Fields in Connections\" deprecation:\nhttps://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate\n"
      enum:
      - SHARED_SERVICE_ENDPOINT
      - SHARED_DEPLOYMENT_ENDPOINT
      - DEDICATED_ENDPOINT
      type: string
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/RoutingMethod'
    schemaName:
      description: 'The schema name from the database connection.

        '
      example: HR or MOVIE
      minLength: 2
      type: string
    secretCompId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment, where the secret will be created in.

        '
      maxLength: 255
      minLength: 0
      type: string
    secretCompartmentId:
      description: "The OCID of the compartment where the GoldenGate Secret will be created. \nIf provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.\n"
      maxLength: 255
      minLength: 1
      type: string
    secretId:
      description: "The OCID of the customer's GoldenGate Service Secret. \nIf provided, it references a key that customers will be required to ensure the policies are established \nto permit GoldenGate to use this Secret.\n"
      maxLength: 255
      minLength: 1
      type: string
    secretName:
      description: Name of the secret with which secret is shown in vault
      type: string
    securityAttributes:
      additionalProperties:
        additionalProperties:
          description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

            '
          type: object
        description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.


          Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

          '
        type: object
      description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

        '
      type: object
    securityGroupId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup.

        It grants administration of security related objects and invoke security related service requests. This role has full privileges.

        '
      maxLength: 255
      minLength: 1
      type: string
    securityPatchUpgradePeriodInDays:
      description: 'Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases.

        Not passing this field during create will equate to using the service default.

        '
      minimum: 0
      type: integer
    sequenceId:
      description: 'Sequence Id

        '
      maxLength: 12
      minLength: 0
      type: string
    sessionMode:
      default: DIRECT
      description: 'The mode of the database connection session to be established by the data client.

        ''REDIRECT'' - for a RAC database, ''DIRECT'' - for a non-RAC database.

        Connection to a RAC database involves a redirection received from the SCAN listeners

        to the database node to connect to. By default the mode would be DIRECT.

        '
      enum:
      - DIRECT
      - REDIRECT
      type: string
    sessionModeOracle:
      default: DIRECT
      description: "Specifies the session mode for the database connection.\nUse REDIRECT only for RAC databases with SCAN listeners that return IP addresses.\nFor RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT.\nIn RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN.\nIt is recommended to configure RAC with FQDN-based SCAN listeners.\n\nThe default is DIRECT, except when databaseId is provided and the discovered database relies on the SCAN listener.\nIn this case, the default is REDIRECT.\n\nDeprecated: Defaulting to the REDIRECT session mode will be removed after April 21, 2027.              \n"
      type: string
      x-obmcs-enumref: '#/definitions/OracleConnection/sessionMode'
    severity:
      description: 'The severity returned when calling GoldenGate API messages for a step in a recipe during pipeline initialization.

        https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html

        '
      enum:
      - INFO
      - ERROR
      - WARNING
      type: string
      x-obmcs-top-level-enum: '#/definitions/SeverityType'
    shouldUseResourcePrincipal:
      description: 'Specifies that the user intends to authenticate to the instance using a resource principal.

        Default: false

        '
      type: boolean
    shouldValidateServerCertificate:
      description: 'If set to true, the driver validates the certificate that is sent by the database server.

        '
      type: boolean
    sizeInBytes:
      description: 'The size of the backup stored in object storage (in bytes)

        '
      format: int64
      type: integer
      x-default-description: 0
    snoozeDeploymentUpgradeType:
      description: 'The type of a deploymentUpgrade snooze.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/SnoozeDeploymentUpgradeType'
    snowflakeAuthType:
      description: 'Used authentication mechanism to access Snowflake.

        '
      type: string
      x-obmcs-enumref: '#/definitions/SnowflakeConnection/authenticationType'
    snowflakeJdbcConnectionUrl:
      description: 'JDBC connection URL.

        e.g.: ''jdbc:snowflake://<account_name>.snowflakecomputing.com/?warehouse=<warehouse-name>&db=<db-name>''

        '
      maxLength: 2000
      minLength: 1
      type: string
    snowflakePassword:
      description: 'The password Oracle GoldenGate uses to connect to Snowflake platform.

        Deprecated: This field is deprecated and replaced by "passwordSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    snowflakePasswordSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform.

        Note: When provided, ''password'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    snowflakePrivateKeyFile:
      description: 'The base64 encoded content of private key file in PEM format.

        Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 65536
      minLength: 0
      type: string
    snowflakePrivateKeyPassphrase:
      description: 'Password if the private key file is encrypted.

        Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 255
      minLength: 0
      type: string
    snowflakePrivateKeyPassphraseSecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file.

        Note: When provided, ''privateKeyPassphrase'' field must not be provided.

        '
      maxLength: 255
      minLength: 0
      type: string
    snowflakeTechnologyType:
      description: The Snowflake technology type.
      type: string
      x-obmcs-enumref: '#/definitions/SnowflakeConnection/technologyType'
    snowflakeUsername:
      description: 'The username Oracle GoldenGate uses to connect to Snowflake.

        This username must already exist and be available by Snowflake platform to be connected to.

        '
      maxLength: 255
      minLength: 1
      type: string
    sourceMapping:
      description: 'The source schema/table combination for replication to target.

        '
      example: HR or HR.* or HR.EMPLOYEE or *.*
      minLength: 3
      type: string
    sslCertificate:
      description: 'The base64 encoded content of the PEM file containing the SSL certificate.

        '
      maxLength: 65536
      minLength: 0
      type: string
    sslPrivateKey:
      description: 'The base64 encoded content of the PEM file containing the private key.

        '
      format: password
      maxLength: 8192
      minLength: 0
      type: string
    sslPrivateKeySecretId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format.

        '
      maxLength: 255
      minLength: 0
      type: string
    startDeploymentType:
      description: 'The type of a deployment start

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/StartDeploymentType'
    startHour:
      description: 'Start hour for maintenance period. Hour is in UTC.

        '
      maximum: 23
      minimum: 0
      type: integer
    startPipelineType:
      description: 'Type of pipeline start. This option applies when starting a pipeline.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/StartPipelineType'
    stepStatus:
      description: 'Status of the steps in a recipe. This option applies during pipeline initialization.

        '
      enum:
      - PENDING
      - IN_PROGRESS
      - COMPLETED
      - FAILED
      type: string
      x-obmcs-top-level-enum: '#/definitions/StepStatusType'
    stopDeploymentType:
      description: 'The type of a deployment stop

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/StopDeploymentType'
    stopPipelineType:
      description: 'Type of a pipeline stop. This option applies when stopping a pipeline.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/StopPipelineType'
    storageUsageLimitPerOcpuInGBs:
      description: 'The multiplier value between CPU core count and storage usage limit size.

        '
      minimum: 1
      type: integer
    storageUtilizationInBytes:
      description: 'The amount of storage being utilized (in bytes)

        '
      format: int64
      type: integer
      x-default-description: 0
    subnetId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline''s private endpoint.

        The subnet must be a private subnet.

        '
      maxLength: 255
      minLength: 0
      type: string
    subscriptionId:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
      maxLength: 255
      minLength: 0
      type: string
    supportedCapabilities:
      description: 'Specifies supported capabilities or features by a deployment type .

        '
      items:
        enum:
        - GROUP_TO_ROLE
        - BACKUP_RESTORE
        - COPY_BACKUP
        - MANUAL_BACKUP
        - PLACEMENT
        - DISASTER_RECOVERY
        - SCHEDULE_MANUAL_BACKUP
        - MULTICLOUD
        - TRAIL_FILES
        - MASTER_KEY_OPERATIONS
        - TRUSTSTORE_CERTIFICATES
        - DEPLOYMENT_DIAGNOSTICS
        - CREDENTIALS
        - CONSOLE_ACCESS
        - NETWORK_CONFIGURATION
        type: string
        x-obmcs-top-level-enum: '#/definitions/SupportedCapabilities'
      type: array
    supportedLicenseTypes:
      description: 'The list of Oracle license models supported by the deployment type.

        '
      items:
        $ref: '#/components/schemas/LicenseModel'
      type: array
    supportedTechnologies:
      description: 'List of the supported technologies generally.  The value is a freeform text string generally consisting

        of a description of the technology and optionally the speific version(s) support.  For example,

        [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ]

        '
      items:
        maxLength: 255
        minLength: 1
        type: string
      type: array
    supportedTechnologiesUrl:
      description: 'The URL to the webpage listing the supported technologies.

        '
      type: string
    supportedTechnologyType:
      description: 'The supported technology type of the recipe.

        '
      enum:
      - OCI_AUTONOMOUS_DATABASE
      - AMAZON_RDS_ORACLE
      - ORACLE_DATABASE
      - ORACLE_EXADATA
      - ORACLE_EXADATA_DATABASE_AT_AZURE
      - ORACLE_AUTONOMOUS_DATABASE_AT_AZURE
      - ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_EXADATA_DATABASE_AT_AWS
      - ORACLE_AUTONOMOUS_DATABASE_AT_AWS
      type: string
      x-obmcs-top-level-enum: '#/definitions/TechnologyType'
    systemTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle

        Cloud Infrastructure services. Each key is predefined and scoped to namespaces.  For more

        information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{orcl-cloud: {free-tier-retain: true}}`

        '
      type: object
      x-default-description: 'null'
    tableName:
      description: 'The table name from the schema of database connection.

        '
      example: EMPLOYEE or ADDRESS
      minLength: 2
      type: string
    targetMapping:
      description: 'The target schema/table combination for replication from the source.

        '
      example: HR or HR.* or HR.EMPLOYEE or *.*
      minLength: 3
      type: string
    technologyType:
      description: 'The technology type. For more details see the documentation.

        '
      enum:
      - GOLDENGATE
      - GENERIC
      - OCI_AUTONOMOUS_DATABASE
      - OCI_AUTONOMOUS_JSON_DATABASE
      - OCI_CACHE_WITH_REDIS
      - OCI_MYSQL
      - OCI_OBJECT_STORAGE
      - OCI_POSTGRESQL
      - OCI_STREAMING
      - OCI_STREAMING_WITH_APACHE_KAFKA
      - ORACLE_DATABASE
      - ORACLE_EXADATA
      - ORACLE_EXADATA_EXASCALE
      - ORACLE_EXADATA_DATABASE_AT_AZURE
      - ORACLE_EXADATA_EXASCALE_AT_AZURE
      - ORACLE_AUTONOMOUS_DATABASE_AT_AZURE
      - ORACLE_JSON_COLLECTION
      - ORACLE_EXADATA_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_EXADATA_EXASCALE_AT_GOOGLE_CLOUD
      - ORACLE_AUTONOMOUS_DATABASE_AT_GOOGLE_CLOUD
      - ORACLE_EXADATA_DATABASE_AT_AWS
      - ORACLE_AUTONOMOUS_DATABASE_AT_AWS
      - ORACLE_AI_DATA_PLATFORM
      - ORACLE_NOSQL
      - ORACLE_REST_DATA_SERVICES
      - ORACLE_WEBLOGIC_JMS
      - AMAZON_RDS_ORACLE
      - AMAZON_RDS_SQLSERVER
      - AMAZON_S3
      - AMAZON_AURORA_MYSQL
      - AMAZON_AURORA_POSTGRESQL
      - AMAZON_DOCUMENT_DB
      - AMAZON_KINESIS
      - AMAZON_REDSHIFT
      - AMAZON_RDS_MARIADB
      - AMAZON_RDS_MYSQL
      - AMAZON_RDS_POSTGRESQL
      - APACHE_ICEBERG
      - APACHE_KAFKA
      - AZURE_COSMOS_DB_FOR_MONGODB
      - AZURE_COSMOS_DB_FOR_POSTGRESQL
      - AZURE_DATA_LAKE_STORAGE
      - AZURE_EVENT_HUBS
      - AZURE_MYSQL
      - AZURE_POSTGRESQL
      - AZURE_SQLSERVER_MANAGED_INSTANCE
      - AZURE_SQLSERVER_NON_MANAGED_INSTANCE
      - AZURE_SYNAPSE_ANALYTICS
      - CONFLUENT_KAFKA
      - CONFLUENT_SCHEMA_REGISTRY
      - DATABRICKS
      - DB2_I
      - DB2_ZOS
      - ELASTICSEARCH
      - EDB_POSTGRES_ADVANCED_SERVER
      - GOOGLE_ALLOY_DB_FOR_POSTGRESQL
      - GOOGLE_BIGQUERY
      - GOOGLE_CLOUD_MANAGED_SERVICE_FOR_APACHE_KAFKA
      - GOOGLE_CLOUD_STORAGE
      - GOOGLE_CLOUD_SQL_MYSQL
      - GOOGLE_CLOUD_SQL_POSTGRESQL
      - GOOGLE_CLOUD_SQL_SQLSERVER
      - GOOGLE_PUBSUB
      - HDFS
      - MARIADB
      - MICROSOFT_SQLSERVER
      - MICROSOFT_FABRIC_EVENTSTREAM
      - MICROSOFT_FABRIC_LAKEHOUSE
      - MICROSOFT_FABRIC_MIRROR
      - MONGODB
      - MYSQL_SERVER
      - MYSQL_HEATWAVE_ON_AZURE
      - MYSQL_HEATWAVE_ON_AWS
      - POSTGRESQL_SERVER
      - REDIS
      - SINGLESTOREDB
      - SINGLESTOREDB_CLOUD
      - SNOWFLAKE
      - YUGABYTE_DB
      - AI_MODEL
      type: string
      x-obmcs-top-level-enum: '#/definitions/TechnologyType'
    tenancyId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related OCI tenancy.

        '
      maxLength: 255
      minLength: 0
      type: string
    testConnectionAssignmentResultType:
      description: 'Type of the Result (i.e. Success or Failure).

        '
      type: string
      x-obmcs-top-level-enum: '#/definitions/TestConnectionAssignmentResult/resultType'
    testConnectionAssignmentType:
      description: 'The type of the test of the assigned connection.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/TestConnectionAssignmentType'
    testPipelineConnectionType:
      description: 'Type of test for an assigned pipeline connection. This option applies when testing a pipeline connection.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/TestPipelineConnectionType'
    timeBackupFinished:
      description: 'The time of the resource backup finish. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
      x-default-description: 'null'
    timeBackupScheduled:
      description: 'The start timestamp for the deployment backup schedule. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

        '
      format: date-time
      type: string
    timeCreated:
      description: 'The time the resource was created. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeDiagnosticEnd:
      description: The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
      format: date-time
      type: string
    timeDiagnosticStart:
      description: The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.
      format: date-time
      type: string
    timeFinished:
      description: 'The date and time the request was finished. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeLastBackupScheduled:
      description: 'The timestamp of last deployment backup scheduled. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`.

        '
      format: date-time
      type: string
    timeLastCollected:
      description: "The date and time the diagnostic data was last collected for the pipeline. The format is defined by \n[RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.\n"
      format: date-time
      type: string
    timeLastFetched:
      description: 'The time the data was last fetched from the deployment. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeLastProcessed:
      description: 'The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes.

        The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeLastRecorded:
      description: 'When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeLastSynced:
      description: 'The time of the last data synchronization from the primary to the standby peer.

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeNextBackupScheduled:
      description: 'The timestamp of next deployment backup scheduled. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

        '
      format: date-time
      type: string
    timeOfBackup:
      description: 'The time of the resource backup. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
      x-default-description: 'null'
    timeOfNextMaintenance:
      description: 'The time of next maintenance schedule. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timePrecheckFinished:
      description: 'The timestamp when pre-check operation finished. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

        '
      format: date-time
      type: string
    timePrecheckStarted:
      description: 'The timestamp when pre-check started. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`.

        '
      format: date-time
      type: string
    timeReleased:
      description: 'The time the resource was released. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeRoleChanged:
      description: 'The time of the last role change. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeSchedule:
      description: 'The time of upgrade schedule. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeScheduleMax:
      description: 'Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeSnoozedUntil:
      description: 'The time the upgrade notifications are snoozed until. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeStarted:
      description: 'The date and time the request was started. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeSupportedUntil:
      description: 'The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeUpdated:
      description: 'The time the resource was last updated. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeValidFrom:
      description: 'The time the certificate is valid from. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timeValidTo:
      description: 'The time the certificate is valid to. The format is defined by

        [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    timestamp:
      description: 'Date and time of a message issued by steps in a recipe during pipeline initialization.

        The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`.

        '
      format: date-time
      type: string
    trailFileId:
      description: 'The TrailFile Id.

        '
      maxLength: 255
      minLength: 0
      type: string
    upgradeDeploymentType:
      description: 'The type of a deployment upgrade

        '
      enum:
      - CURRENT_RELEASE
      - SPECIFIC_RELEASE
      type: string
      x-obmcs-top-level-enum: '#/definitions/UpgradeDeploymentType'
    upgradeDeploymentUpgradeType:
      description: 'The type of a deployment start.

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/UpgradeDeploymentUpgradeType'
    url:
      description: 'The URL of a resource.

        '
      minLength: 0
      type: string
    userGroupId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup.

        It allows information-only service requests, which do not alter or affect the operation of either the MA.

        Examples of query and read-only information include performance metric information and resource status and monitoring information

        '
      maxLength: 255
      minLength: 0
      type: string
    username:
      description: 'The username Oracle GoldenGate uses to connect the associated system of the given technology.

        This username must already exist and be available by the system/application to be connected to

        and must conform to the case sensitivty requirments defined in it.

        '
      maxLength: 255
      minLength: 0
      type: string
    vaultId:
      description: "Refers to the customer's vault OCID. \nIf provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate\nto manage secrets contained within this vault.\n"
      maxLength: 255
      minLength: 0
      type: string
    wallet:
      description: 'The wallet contents Oracle GoldenGate uses to make connections to a database.

        This attribute is expected to be base64 encoded.

        Deprecated: This field is deprecated and replaced by "walletSecretId".

        This change follows the GoldenGate "Plain Text Fields in Connections" deprecation:

        https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

        '
      format: password
      maxLength: 51200
      minLength: 0
      type: string
    walletExistsDeploymentType:
      description: 'The type of a deployment for wallet

        '
      enum:
      - DEFAULT
      type: string
      x-obmcs-top-level-enum: '#/definitions/WalletExistsDeploymentType'
    walletSecretId:
      description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored. \nThe wallet contents Oracle GoldenGate uses to make connections to a database.\nNote: When provided, 'wallet' field must not be provided.\n"
      maxLength: 255
      minLength: 0
      type: string
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.ggs