// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.cloud.oracledatabase.v1;

import "google/api/field_behavior.proto";
import "google/api/field_info.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/type/dayofweek.proto";

option csharp_namespace = "Google.Cloud.OracleDatabase.V1";
option go_package = "cloud.google.com/go/oracledatabase/apiv1/oracledatabasepb;oracledatabasepb";
option java_multiple_files = true;
option java_outer_classname = "GoldengateDeploymentProto";
option java_package = "com.google.cloud.oracledatabase.v1";
option php_namespace = "Google\\Cloud\\OracleDatabase\\V1";
option ruby_package = "Google::Cloud::OracleDatabase::V1";

// GoldengateDeployment Goldengate Deployment resource model.
message GoldengateDeployment {
  option (google.api.resource) = {
    type: "oracledatabase.googleapis.com/GoldengateDeployment"
    pattern: "projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}"
    plural: "goldengateDeployments"
    singular: "goldengateDeployment"
  };

  // Identifier. The name of the GoldengateDeployment resource in the following
  // format:
  // projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
  string name = 1 [(google.api.field_behavior) = IDENTIFIER];

  // Required. The properties of the GoldengateDeployment.
  GoldengateDeploymentProperties properties = 2
      [(google.api.field_behavior) = REQUIRED];

  // Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted.
  // Example: us-east4-b-r2.
  // If not specified, the system will pick a zone based on availability.
  string gcp_oracle_zone = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The labels or tags associated with the GoldengateDeployment.
  map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The name of the OdbNetwork associated with the
  // GoldengateDeployment.
  string odb_network = 5 [
    (google.api.field_behavior) = OPTIONAL,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/OdbNetwork"
    }
  ];

  // Required. The name of the OdbSubnet associated with the
  // GoldengateDeployment for IP allocation.
  string odb_subnet = 6 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/OdbSubnet"
    }
  ];

  // Output only. The ID of the subscription entitlement associated with the
  // GoldengateDeployment
  string entitlement_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. The display name for the GoldengateDeployment.
  string display_name = 8 [(google.api.field_behavior) = REQUIRED];

  // Output only. The date and time that the GoldengateDeployment was created.
  google.protobuf.Timestamp create_time = 9
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. HTTPS link to OCI resources exposed to Customer via UI
  // Interface.
  string oci_url = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Properties of GoldengateDeployment.
message GoldengateDeploymentProperties {
  // The various lifecycle states of the GoldengateDeployment.
  enum GoldengateDeploymentLifecycleState {
    // Default unspecified value.
    GOLDENGATE_DEPLOYMENT_LIFECYCLE_STATE_UNSPECIFIED = 0;

    // The deployment is being created.
    CREATING = 1;

    // The deployment is being updated.
    UPDATING = 2;

    // The deployment is active.
    ACTIVE = 3;

    // The deployment is inactive.
    INACTIVE = 4;

    // The deployment is being deleted.
    DELETING = 5;

    // The deployment is deleted.
    DELETED = 6;

    // The deployment failed.
    FAILED = 7;

    // The deployment needs attention.
    NEEDS_ATTENTION = 8;

    // The deployment is in progress.
    IN_PROGRESS = 9;

    // The deployment is canceling.
    CANCELLING = 10;

    // The deployment is canceled.
    CANCELLED = 11;

    // The deployment succeeded.
    SUCCEEDED = 12;

    // The deployment is waiting.
    WAITING = 13;
  }

  // The license model of the GoldengateDeployment.
  enum LicenseModel {
    // The license model is unspecified.
    LICENSE_MODEL_UNSPECIFIED = 0;

    // The license model is included.
    LICENSE_INCLUDED = 1;

    // The license model is bring your own license.
    BRING_YOUR_OWN_LICENSE = 2;
  }

  // The various lifecycle sub-states of the GoldengateDeployment.
  enum GoldengateDeploymentLifecycleSubState {
    // The lifecycle sub-state is unspecified.
    GOLDENGATE_DEPLOYMENT_LIFECYCLE_SUB_STATE_UNSPECIFIED = 0;

    // The deployment is recovering.
    RECOVERING = 1;

    // The deployment is starting.
    STARTING = 2;

    // The deployment is stopping.
    STOPPING = 3;

    // The deployment is moving.
    MOVING = 4;

    // The deployment is upgrading.
    UPGRADING = 5;

    // The deployment is restoring.
    RESTORING = 6;

    // The deployment is backing up.
    BACKING_UP = 7;

    // The deployment is rolling back.
    ROLLING_BACK = 8;
  }

  // The category of the GoldengateDeployment.
  enum GoldengateDeploymentCategory {
    // The category is unspecified.
    GOLDENGATE_DEPLOYMENT_CATEGORY_UNSPECIFIED = 0;

    // The deployment is data replication.
    DATA_REPLICATION = 1;

    // The deployment is data transforms.
    DATA_TRANSFORMS = 2;
  }

  // The various next maintenance action types of the GoldengateDeployment.
  enum NextMaintenanceActionType {
    // The next maintenance action type is unspecified.
    NEXT_MAINTENANCE_ACTION_TYPE_UNSPECIFIED = 0;

    // The next maintenance action type is upgrade.
    UPGRADE = 1;
  }

  // The deployment role type of the GoldengateDeployment.
  enum GoldengateDeploymentRoleType {
    // The deployment role type is unspecified.
    GOLDENGATE_DEPLOYMENT_ROLE_TYPE_UNSPECIFIED = 0;

    // The deployment role type is primary.
    PRIMARY = 1;

    // The deployment role type is standby.
    STANDBY = 2;
  }

  // Output only. OCID of the GoldengateDeployment.
  string ocid = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. State of the GoldengateDeployment.
  GoldengateDeploymentLifecycleState lifecycle_state = 2
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Optional. The Oracle license model that applies to a Deployment.
  LicenseModel license_model = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The environment type of the GoldengateDeployment.
  string environment_type = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The Minimum number of OCPUs to be made available for this
  // Deployment.
  int32 cpu_core_count = 5 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Indicates if auto scaling is enabled for the Deployment's CPU
  // core count.
  bool is_auto_scaling_enabled = 6 [(google.api.field_behavior) = OPTIONAL];

  // Optional. The description of the GoldengateDeployment.
  string description = 7 [(google.api.field_behavior) = OPTIONAL];

  // Required. A valid Goldengate Deployment type. For a list of supported
  // types, use the `ListGoldengateDeploymentTypes` operation.
  string deployment_type = 8 [(google.api.field_behavior) = REQUIRED];

  // Required. The ogg data of the GoldengateDeployment.
  GoldengateOggDeployment ogg_data = 9 [(google.api.field_behavior) = REQUIRED];

  // Optional. The maintenance window of the GoldengateDeployment.
  GoldengateMaintenanceWindow maintenance_window = 10
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. The maintenance configuration of the GoldengateDeployment.
  GoldengateMaintenanceConfig maintenance_config = 11
      [(google.api.field_behavior) = OPTIONAL];

  // Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
  string fqdn = 12 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The lifecycle sub-state of the GoldengateDeployment.
  GoldengateDeploymentLifecycleSubState lifecycle_sub_state = 13
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The category of the GoldengateDeployment.
  GoldengateDeploymentCategory category = 14
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The deployment backup id of the GoldengateDeployment.
  string deployment_backup_id = 15 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time the GoldengateDeployment was updated.
  google.protobuf.Timestamp update_time = 16
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The lifecycle details of the GoldengateDeployment.
  string lifecycle_details = 17 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Whether the GoldengateDeployment is healthy.
  bool healthy = 18 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The load balancer subnet id of the GoldengateDeployment.
  string load_balancer_subnet_id = 19
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The load balancer id of the GoldengateDeployment.
  string load_balancer_id = 20 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The nsg ids of the GoldengateDeployment.
  repeated string nsg_ids = 21 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Whether the GoldengateDeployment is public.
  bool is_public = 22 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The public ip address of the GoldengateDeployment.
  string public_ip_address = 23 [
    (google.api.field_info).format = IPV4_OR_IPV6,
    (google.api.field_behavior) = OUTPUT_ONLY
  ];

  // Output only. The private ip address of the GoldengateDeployment.
  string private_ip_address = 24 [
    (google.api.field_info).format = IPV4_OR_IPV6,
    (google.api.field_behavior) = OUTPUT_ONLY
  ];

  // Output only. The deployment url of the GoldengateDeployment.
  string deployment_url = 25 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Whether the GoldengateDeployment is of the latest version.
  bool is_latest_version = 26 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time upgrade required of the GoldengateDeployment.
  google.protobuf.Timestamp upgrade_required_time = 27
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The storage utilization in bytes of the GoldengateDeployment.
  int64 storage_utilization_bytes = 28
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Whether storage utilization limit is exceeded of the
  // GoldengateDeployment.
  bool is_storage_utilization_limit_exceeded = 29
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The deployment diagnostic data of the GoldengateDeployment.
  DeploymentDiagnosticData deployment_diagnostic_data = 30
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The backup schedule of the GoldengateDeployment.
  GoldengateBackupSchedule backup_schedule = 31
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time of next maintenance of the GoldengateDeployment.
  google.protobuf.Timestamp next_maintenance_time = 32
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The next maintenance action type of the GoldengateDeployment.
  NextMaintenanceActionType next_maintenance_action_type = 33
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The next maintenance description of the GoldengateDeployment.
  string next_maintenance_description = 34
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time ogg version supported until of the
  // GoldengateDeployment.
  google.protobuf.Timestamp ogg_version_support_end_time = 35
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The ingress ips of the GoldengateDeployment.
  repeated IngressIp ingress_ips = 36
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The deployment role of the GoldengateDeployment.
  GoldengateDeploymentRoleType deployment_role = 37
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time last backup scheduled of the GoldengateDeployment.
  google.protobuf.Timestamp last_backup_schedule_time = 38
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time next backup scheduled of the GoldengateDeployment.
  google.protobuf.Timestamp next_backup_schedule_time = 39
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time when the role of the GoldengateDeployment was
  // changed.
  google.protobuf.Timestamp role_change_time = 40
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The locks of the GoldengateDeployment.
  repeated GoldengateDeploymentLock locks = 41
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The placements of the GoldengateDeployment.
  repeated GoldengatePlacement placements = 42
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The Ogg data of the GoldengateDeployment.
message GoldengateOggDeployment {
  // The credential store of the GoldengateDeployment.
  enum CredentialStore {
    // The credential store is unspecified.
    CREDENTIAL_STORE_UNSPECIFIED = 0;

    // The credential store is Goldengate.
    GOLDENGATE = 1;

    // The credential store is IAM.
    IAM = 2;
  }

  // The Goldengate deployment console password.
  oneof deployment_password_options {
    // Optional. The Goldengate deployment console password in plain text.
    string admin_password = 3 [(google.api.field_behavior) = OPTIONAL];

    // Optional. Input only. The Goldengate deployment console password secret
    // version.
    string admin_password_secret_version = 10 [
      (google.api.field_behavior) = OPTIONAL,
      (google.api.field_behavior) = INPUT_ONLY,
      (google.api.resource_reference) = {
        type: "secretmanager.googleapis.com/SecretVersion"
      }
    ];
  }

  // Required. 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.
  string deployment = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The Goldengate deployment console username.
  string admin_username = 2 [(google.api.field_behavior) = REQUIRED];

  // Optional. Version of OGG
  string ogg_version = 4 [(google.api.field_behavior) = OPTIONAL];

  // Output only. The certificate of the GoldengateDeployment.
  string certificate = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The credential store of the GoldengateDeployment.
  CredentialStore credential_store = 6
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The identity domain id of the GoldengateDeployment.
  string identity_domain_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The password secret id of the GoldengateDeployment.
  string password_secret_id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The group to roles mapping of the GoldengateDeployment.
  GoldengateGroupToRolesMapping group_roles_mapping = 9
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The maintenance window of the GoldengateDeployment.
message GoldengateMaintenanceWindow {
  // Required. Days of the week.
  google.type.DayOfWeek day = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. Start hour for maintenance period. Hour is in UTC.
  int32 start_hour = 2 [(google.api.field_behavior) = REQUIRED];
}

// The maintenance configuration of the GoldengateDeployment.
message GoldengateMaintenanceConfig {
  // Optional. By default auto upgrade for interim releases are not enabled. If
  // auto-upgrade is enabled for interim release,  you have to specify
  // interim_release_upgrade_period_days too.
  bool is_interim_release_auto_upgrade_enabled = 1
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. Defines auto upgrade period for interim releases. This period
  // must be shorter or equal to bundle release upgrade period.
  int32 interim_release_upgrade_period_days = 2
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. 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.
  int32 bundle_release_upgrade_period_days = 3
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. 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.
  int32 major_release_upgrade_period_days = 4
      [(google.api.field_behavior) = OPTIONAL];

  // Optional. 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.
  int32 security_patch_upgrade_period_days = 5
      [(google.api.field_behavior) = OPTIONAL];
}

// The deployment diagnostic data.
message DeploymentDiagnosticData {
  // The possible states of the diagnostic data.
  enum DiagnosticState {
    // The diagnostic state is unspecified.
    DIAGNOSTIC_STATE_UNSPECIFIED = 0;

    // The diagnostic is in progress.
    IN_PROGRESS = 1;

    // The diagnostic completed successfully.
    SUCCEEDED = 2;

    // The diagnostic failed.
    FAILED = 3;
  }

  // Output only. The namespace name.
  string namespace = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The bucket name.
  string bucket = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The object name.
  string object = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The diagnostic state.
  DiagnosticState diagnostic_state = 4
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time diagnostic start.
  google.protobuf.Timestamp diagnostic_start_time = 5
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time diagnostic end.
  google.protobuf.Timestamp diagnostic_end_time = 6
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The backup schedule of the GoldengateDeployment.
message GoldengateBackupSchedule {
  // Enum for frequency backup scheduled.
  enum FrequencyBackupScheduled {
    // The frequency backup scheduled is unspecified.
    FREQUENCY_BACKUP_SCHEDULED_UNSPECIFIED = 0;

    // The frequency backup scheduled is daily.
    DAILY = 1;

    // The frequency backup scheduled is weekly.
    WEEKLY = 2;

    // The frequency backup scheduled is monthly.
    MONTHLY = 3;
  }

  // Output only. The bucket name.
  string bucket = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The compartment id.
  string compartment_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The frequency backup scheduled.
  FrequencyBackupScheduled frequency_backup_scheduled = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. If metadata only.
  bool metadata_only = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The namespace name.
  string namespace = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The timestamp of when the backup was scheduled.
  google.protobuf.Timestamp backup_scheduled_time = 6
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The ingress IPs of the GoldengateDeployment.
message IngressIp {
  // Output only. The ingress IP.
  string ingress_ip_address = 1 [
    (google.api.field_info).format = IPV4_OR_IPV6,
    (google.api.field_behavior) = OUTPUT_ONLY
  ];
}

// The lock of the GoldengateDeployment.
message GoldengateDeploymentLock {
  // The type of lock.
  enum LockType {
    // The lock type is unspecified.
    LOCK_TYPE_UNSPECIFIED = 0;

    // The lock type is full.
    FULL = 1;

    // The lock type is delete.
    DELETE = 2;
  }

  // Output only. The type of lock.
  LockType type = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The compartment id.
  string compartment_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The related resource id.
  string related_resource_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The message.
  string message = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The time created.
  google.protobuf.Timestamp create_time = 5
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The placement of the GoldengateDeployment.
message GoldengatePlacement {
  // Output only. The availability domain.
  string availability_domain = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The fault domain.
  string fault_domain = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The group to roles mapping of the GoldengateDeployment.
message GoldengateGroupToRolesMapping {
  // Output only. The security group id.
  string security_group_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The administrator group id.
  string administrator_group_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The operator group id.
  string operator_group_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The user group id.
  string user_group_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// The request for `GoldengateDeployment.Create`.
message CreateGoldengateDeploymentRequest {
  // Required. The value for parent of the GoldengateDeployment in the following
  // format: projects/{project}/locations/{location}.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      child_type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];

  // Required. The ID of the GoldengateDeployment to create. This value is
  // restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of
  // 63 characters in length. The value must start with a letter and end with a
  // letter or a number.
  string goldengate_deployment_id = 2 [(google.api.field_behavior) = REQUIRED];

  // Required. The resource being created.
  GoldengateDeployment goldengate_deployment = 3
      [(google.api.field_behavior) = REQUIRED];

  // Optional. An optional request ID to identify requests. Specify a unique
  // request ID so that if you must retry your request, the server will know to
  // ignore the request if it has already been completed. The server will
  // guarantee that for at least 60 minutes since the first request.
  //
  // For example, consider a situation where you make an initial request and the
  // request times out. If you make the request again with the same request
  // ID, the server can check if original operation with the same request ID
  // was received, and if so, will ignore the second request. This prevents
  // clients from accidentally creating duplicate commitments.
  //
  // The request ID must be a valid UUID with the exception that zero UUID is
  // not supported (00000000-0000-0000-0000-000000000000).
  string request_id = 4 [
    (google.api.field_info).format = UUID4,
    (google.api.field_behavior) = OPTIONAL
  ];
}

// The request for `GoldengateDeployment.Delete`.
message DeleteGoldengateDeploymentRequest {
  // Required. The name of the GoldengateDeployment in the following format:
  // projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];

  // Optional. An optional ID to identify the request. This value is used to
  // identify duplicate requests. If you make a request with the same request ID
  // and the original request is still in progress or completed, the server
  // ignores the second request. This prevents clients from
  // accidentally creating duplicate commitments.
  //
  // The request ID must be a valid UUID with the exception that zero UUID is
  // not supported (00000000-0000-0000-0000-000000000000).
  string request_id = 2 [
    (google.api.field_info).format = UUID4,
    (google.api.field_behavior) = OPTIONAL
  ];
}

// The request for `GoldengateDeployment.Get`.
message GetGoldengateDeploymentRequest {
  // Required. The name of the GoldengateDeployment in the following format:
  // projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];
}

// The request for `GoldengateDeployment.List`.
message ListGoldengateDeploymentsRequest {
  // Required. The parent value for GoldengateDeployments in the following
  // format: projects/{project}/locations/{location}.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      child_type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];

  // Optional. The maximum number of items to return.
  // If unspecified, at most 50 GoldengateDeployments will be returned.
  // The maximum value is 1000; values above 1000 will be coerced to 1000.
  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

  // Optional. A page token, received from a previous ListGoldengateDeployments
  // call. Provide this to retrieve the subsequent page.
  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. An expression for filtering the results of the request.
  string filter = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. An expression for ordering the results of the request.
  string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
}

// The response for `GoldengateDeployment.List`.
message ListGoldengateDeploymentsResponse {
  // The list of GoldengateDeployments.
  repeated GoldengateDeployment goldengate_deployments = 1;

  // A token identifying a page of results the server should return.
  string next_page_token = 2;

  // Optional. Locations that could not be reached.
  repeated string unreachable = 3 [(google.api.field_behavior) = OPTIONAL];
}

// The request for `GoldengateDeployment.Stop`.
message StopGoldengateDeploymentRequest {
  // Required. The name of the Goldengate Deployment in the following format:
  // projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];
}

// The request for `GoldengateDeployment.Start`.
message StartGoldengateDeploymentRequest {
  // Required. The name of the Goldengate Deployment in the following format:
  // projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "oracledatabase.googleapis.com/GoldengateDeployment"
    }
  ];
}