// Copyright 2023 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
//
//      https://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.

// Generated by the C++ microgenerator.
// If you make any local changes, they will be lost.
// file:///workspace/generator/discovery/compute_public_google_rest_v1.json
// revision: 20231110

syntax = "proto3";

package google.cloud.cpp.compute.v1;

// Represents a Health-Check as a Service resource.
message HealthCheckService {
  // [Output Only] Creation timestamp in RFC3339 text format.
  optional string creation_timestamp = 1 [json_name = "creationTimestamp"];

  // An optional description of this resource. Provide this property when you
  // create the resource.
  optional string description = 2 [json_name = "description"];

  // Fingerprint of this resource. A hash of the contents stored in this object.
  // This field is used in optimistic locking. This field will be ignored when
  // inserting a HealthCheckService. An up-to-date fingerprint must be provided
  // in order to patch/update the HealthCheckService; Otherwise, the request
  // will fail with error 412 conditionNotMet. To see the latest fingerprint,
  // make a get() request to retrieve the HealthCheckService.
  optional string fingerprint = 3 [json_name = "fingerprint"];

  // A list of URLs to the HealthCheck resources. Must have at least one
  // HealthCheck, and not more than 10 for regional HealthCheckService, and not
  // more than 1 for global HealthCheckService. HealthCheck resources must have
  // portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For
  // regional HealthCheckService, the HealthCheck must be regional and in the
  // same region. For global HealthCheckService, HealthCheck must be global. Mix
  // of regional and global HealthChecks is not supported. Multiple regional
  // HealthChecks must belong to the same region. Regional HealthChecks must
  // belong to the same region as zones of NetworkEndpointGroups. For global
  // HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the
  // global HealthChecks must specify sourceRegions, and HealthChecks that
  // specify sourceRegions can only be used with global INTERNET_IP_PORT
  // NetworkEndpointGroups.
  repeated string health_checks = 4 [json_name = "healthChecks"];

  // Optional. Policy for how the results from multiple health checks for the
  // same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. -
  // NO_AGGREGATION. An EndpointHealth message is returned for each pair in the
  // health check service. - AND. If any health check of an endpoint reports
  // UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health
  // checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This
  // is only allowed with regional HealthCheckService.
  // AND: If any backend's health check reports UNHEALTHY, then UNHEALTHY is the
  // HealthState of the entire health check service. If all backend's are
  // healthy, the HealthState of the health check service is HEALTHY.
  // NO_AGGREGATION: An EndpointHealth message is returned for each backend in
  // the health check service.
  optional string health_status_aggregation_policy = 5
      [json_name = "healthStatusAggregationPolicy"];

  // [Output Only] The unique identifier for the resource. This identifier is
  // defined by the server.
  optional string id = 6 [json_name = "id"];

  // [Output only] Type of the resource. Always compute#healthCheckServicefor
  // health check services.
  optional string kind = 7 [json_name = "kind"];

  // Name of the resource. The name must be 1-63 characters long, and comply
  // with RFC1035. Specifically, the name must be 1-63 characters long and match
  // the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
  // character must be a lowercase letter, and all following characters must be
  // a dash, lowercase letter, or digit, except the last character, which cannot
  // be a dash.
  optional string name = 8 [json_name = "name"];

  // A list of URLs to the NetworkEndpointGroup resources. Must not have more
  // than 100. For regional HealthCheckService, NEGs must be in zones in the
  // region of the HealthCheckService. For global HealthCheckServices, the
  // NetworkEndpointGroups must be global INTERNET_IP_PORT.
  repeated string network_endpoint_groups = 9
      [json_name = "networkEndpointGroups"];

  // A list of URLs to the NotificationEndpoint resources. Must not have more
  // than 10. A list of endpoints for receiving notifications of change in
  // health status. For regional HealthCheckService, NotificationEndpoint must
  // be regional and in the same region. For global HealthCheckService,
  // NotificationEndpoint must be global.
  repeated string notification_endpoints = 10
      [json_name = "notificationEndpoints"];

  // [Output Only] URL of the region where the health check service resides.
  // This field is not applicable to global health check services. You must
  // specify this field as part of the HTTP request URL. It is not settable as a
  // field in the request body.
  optional string region = 11 [json_name = "region"];

  // [Output Only] Server-defined URL for the resource.
  optional string self_link = 12 [json_name = "selfLink"];
}

message HealthCheckServicesList {
  // [Output Only] Unique identifier for the resource; defined by the server.
  optional string id = 1 [json_name = "id"];

  // A list of HealthCheckService resources.
  repeated HealthCheckService items = 2 [json_name = "items"];

  // [Output Only] Type of the resource. Always compute#healthCheckServicesList
  // for lists of HealthCheckServices.
  optional string kind = 3 [json_name = "kind"];

  // [Output Only] This token allows you to get the next page of results for
  // list requests. If the number of results is larger than maxResults, use the
  // nextPageToken as a value for the query parameter pageToken in the next list
  // request. Subsequent list requests will have their own nextPageToken to
  // continue paging through the results.
  optional string next_page_token = 4 [json_name = "nextPageToken"];

  // [Output Only] Server-defined URL for this resource.
  optional string self_link = 5 [json_name = "selfLink"];

  message Warning {
    // [Output Only] A warning code, if applicable. For example, Compute Engine
    // returns NO_RESULTS_ON_PAGE if there are no results in the response.
    // CLEANUP_FAILED: Warning about failed cleanup of transient changes made by
    // a failed operation.
    // DEPRECATED_RESOURCE_USED: A link to a deprecated resource was created.
    // DEPRECATED_TYPE_USED: When deploying and at least one of the resources
    // has a type marked as deprecated
    // DISK_SIZE_LARGER_THAN_IMAGE_SIZE: The user created a boot disk that is
    // larger than image size.
    // EXPERIMENTAL_TYPE_USED: When deploying and at least one of the resources
    // has a type marked as experimental
    // EXTERNAL_API_WARNING: Warning that is present in an external api call
    // FIELD_VALUE_OVERRIDEN: Warning that value of a field has been overridden.
    // Deprecated unused field.
    // INJECTED_KERNELS_DEPRECATED: The operation involved use of an injected
    // kernel, which is deprecated.
    // INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB: A WEIGHTED_MAGLEV backend
    // service is associated with a health check that is not of type
    // HTTP/HTTPS/HTTP2.
    // LARGE_DEPLOYMENT_WARNING: When deploying a deployment with a exceedingly
    // large number of resources
    // LIST_OVERHEAD_QUOTA_EXCEED: Resource can't be retrieved due to list
    // overhead quota exceed which captures the amount of resources filtered out
    // by user-defined list filter.
    // MISSING_TYPE_DEPENDENCY: A resource depends on a missing type
    // NEXT_HOP_ADDRESS_NOT_ASSIGNED: The route's nextHopIp address is not
    // assigned to an instance on the network.
    // NEXT_HOP_CANNOT_IP_FORWARD: The route's next hop instance cannot ip
    // forward.
    // NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE: The route's nextHopInstance URL
    // refers to an instance that does not have an ipv6 interface on the same
    // network as the route.
    // NEXT_HOP_INSTANCE_NOT_FOUND: The route's nextHopInstance URL refers to an
    // instance that does not exist.
    // NEXT_HOP_INSTANCE_NOT_ON_NETWORK: The route's nextHopInstance URL refers
    // to an instance that is not on the same network as the route.
    // NEXT_HOP_NOT_RUNNING: The route's next hop instance does not have a
    // status of RUNNING.
    // NOT_CRITICAL_ERROR: Error which is not critical. We decided to continue
    // the process despite the mentioned error.
    // NO_RESULTS_ON_PAGE: No results are present on a particular list page.
    // PARTIAL_SUCCESS: Success is reported, but some results may be missing due
    // to errors
    // REQUIRED_TOS_AGREEMENT: The user attempted to use a resource that
    // requires a TOS they have not accepted.
    // RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING: Warning that a resource is in
    // use.
    // RESOURCE_NOT_DELETED: One or more of the resources set to auto-delete
    // could not be deleted because they were in use.
    // SCHEMA_VALIDATION_IGNORED: When a resource schema validation is ignored.
    // SINGLE_INSTANCE_PROPERTY_TEMPLATE: Instance template used in instance
    // group manager is valid as such, but its application does not make a lot
    // of sense, because it allows only single instance in instance group.
    // UNDECLARED_PROPERTIES: When undeclared properties in the schema are
    // present
    // UNREACHABLE: A given scope cannot be reached.
    optional string code = 1 [json_name = "code"];

    message DataItem {
      // [Output Only] A key that provides more detail on the warning being
      // returned. For example, for warnings where there are no results in a
      // list request for a particular zone, this key might be scope and the key
      // value might be the zone name. Other examples might be a key indicating
      // a deprecated resource and a suggested replacement, or a warning about
      // invalid network settings (for example, if an instance attempts to
      // perform IP forwarding but is not enabled for IP forwarding).
      optional string key = 1 [json_name = "key"];

      // [Output Only] A warning data value corresponding to the key.
      optional string value = 2 [json_name = "value"];
    }

    // [Output Only] Metadata about this warning in key: value format. For
    // example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
    repeated DataItem data = 2 [json_name = "data"];

    // [Output Only] A human-readable description of the warning code.
    optional string message = 3 [json_name = "message"];
  }

  // [Output Only] Informational warning message.
  optional Warning warning = 6 [json_name = "warning"];
}
