// Copyright 2020 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.visualinspection.v1beta1;

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/visualinspection/v1beta1/annotation_spec.proto";
import "google/protobuf/timestamp.proto";
import "google/type/color.proto";

option csharp_namespace = "Google.Cloud.VisualInspection.V1Beta1";
option php_namespace = "Google\\Cloud\\VisualInspection\\V1beta1";
option ruby_package = "Google::Cloud::VisualInspection::V1beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/visualinspection/v1beta1;visualinspection";
option java_multiple_files = true;
option java_package = "com.google.cloud.visualinspection.v1beta1";

// Resource of an AnnotationSet.
message AnnotationSet {
  option (google.api.resource) = {
    type: "visualinspection.googleapis.com/AnnotationSet"
    pattern: "projects/{project}/locations/{location}/datasets/{dataset}/annotationSets/{annotation_set}"
  };

  // Type of the Annotations in this AnnotationSet. Annotations in this
  // AnnotationSet must be of the same type.
  oneof annotation_set_type {
    // Classification label.
    ClassificationLabelAnnotationSet classification_label = 3;

    // Bounding box.
    BoundingBoxAnnotationSet box = 4;

    // Polygon.
    PolygonAnnotationSet polygon = 5;

    // Mask.
    MaskAnnotationSet mask = 6;

    // Polyline
    PolylineAnnotationSet polyline = 11;
  }

  // Output only. Resource name of the AnnotationSet generated by the system.
  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Required. A user friendly display name for the annotationset.
  // It can be up to 128 characters long and can be consist of any UTF-8
  // characters.
  string display_name = 2 [(google.api.field_behavior) = REQUIRED];

  // Output only. Timestamp when this AnnotationSet was created.
  google.protobuf.Timestamp create_time = 7
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. Timestamp when AnnotationSet was last updated.
  google.protobuf.Timestamp update_time = 8
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The list of the AnnotationSpecs in the context of the
  // AnnotationSet. All of the AnnotationSpecs that are imported or created into
  // the AnnotationSet are automatically added to this list. User can manually
  // add item to this list even though no annotation is associated with the
  // corresponding AnnotationSpec.
  repeated AnnotationSpec annotation_specs = 9
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// ClassificationLabel Annotation type.
message ClassificationLabelAnnotationSet {
  // Whether or not the classification annotation is a multi-label
  // classification.
  bool multi_label = 1;
}

// BoundingBox Annotation type.
message BoundingBoxAnnotationSet {}

// Polygon Annotation type.
message PolygonAnnotationSet {}

// Mask Annotation type.
message MaskAnnotationSet {
  // Mapping of color to annotationspec.
  // For example,
  // annotation_spec_colors {
  //  annotation_spec_id: 1
  //  red: 0
  //  green: 1
  //  blue:0
  // }
  // it means green color maps to annotation_spec_id==1.
  repeated AnnotationSpecColor annotation_spec_colors = 1;
}

// Mapping of color to AnnotationSpec
message AnnotationSpecColor {
  // AnnotationSpec Id.
  string annotation_spec_id = 1;

  // RGB value represents color in the category_mask image.
  // Alpha value will always be empty.
  google.type.Color color = 2;
}

// Polyline Annotation type.
message PolylineAnnotationSet {}
