1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/vision/v1/product_search_service.proto 18 19 package com.google.cloud.vision.v1; 20 21 public interface ReferenceImageOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.vision.v1.ReferenceImage) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The resource name of the reference image. 31 * Format is: 32 * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. 33 * This field is ignored when creating a reference image. 34 * </pre> 35 * 36 * <code>string name = 1;</code> 37 * 38 * @return The name. 39 */ getName()40 java.lang.String getName(); 41 /** 42 * 43 * 44 * <pre> 45 * The resource name of the reference image. 46 * Format is: 47 * `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. 48 * This field is ignored when creating a reference image. 49 * </pre> 50 * 51 * <code>string name = 1;</code> 52 * 53 * @return The bytes for name. 54 */ getNameBytes()55 com.google.protobuf.ByteString getNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Required. The Google Cloud Storage URI of the reference image. 62 * The URI must start with `gs://`. 63 * </pre> 64 * 65 * <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> 66 * 67 * @return The uri. 68 */ getUri()69 java.lang.String getUri(); 70 /** 71 * 72 * 73 * <pre> 74 * Required. The Google Cloud Storage URI of the reference image. 75 * The URI must start with `gs://`. 76 * </pre> 77 * 78 * <code>string uri = 2 [(.google.api.field_behavior) = REQUIRED];</code> 79 * 80 * @return The bytes for uri. 81 */ getUriBytes()82 com.google.protobuf.ByteString getUriBytes(); 83 84 /** 85 * 86 * 87 * <pre> 88 * Optional. Bounding polygons around the areas of interest in the reference image. 89 * If this field is empty, the system will try to detect regions of 90 * interest. At most 10 bounding polygons will be used. 91 * The provided shape is converted into a non-rotated rectangle. Once 92 * converted, the small edge of the rectangle must be greater than or equal 93 * to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 94 * is not). 95 * </pre> 96 * 97 * <code> 98 * repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL]; 99 * </code> 100 */ getBoundingPolysList()101 java.util.List<com.google.cloud.vision.v1.BoundingPoly> getBoundingPolysList(); 102 /** 103 * 104 * 105 * <pre> 106 * Optional. Bounding polygons around the areas of interest in the reference image. 107 * If this field is empty, the system will try to detect regions of 108 * interest. At most 10 bounding polygons will be used. 109 * The provided shape is converted into a non-rotated rectangle. Once 110 * converted, the small edge of the rectangle must be greater than or equal 111 * to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 112 * is not). 113 * </pre> 114 * 115 * <code> 116 * repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL]; 117 * </code> 118 */ getBoundingPolys(int index)119 com.google.cloud.vision.v1.BoundingPoly getBoundingPolys(int index); 120 /** 121 * 122 * 123 * <pre> 124 * Optional. Bounding polygons around the areas of interest in the reference image. 125 * If this field is empty, the system will try to detect regions of 126 * interest. At most 10 bounding polygons will be used. 127 * The provided shape is converted into a non-rotated rectangle. Once 128 * converted, the small edge of the rectangle must be greater than or equal 129 * to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 130 * is not). 131 * </pre> 132 * 133 * <code> 134 * repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL]; 135 * </code> 136 */ getBoundingPolysCount()137 int getBoundingPolysCount(); 138 /** 139 * 140 * 141 * <pre> 142 * Optional. Bounding polygons around the areas of interest in the reference image. 143 * If this field is empty, the system will try to detect regions of 144 * interest. At most 10 bounding polygons will be used. 145 * The provided shape is converted into a non-rotated rectangle. Once 146 * converted, the small edge of the rectangle must be greater than or equal 147 * to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 148 * is not). 149 * </pre> 150 * 151 * <code> 152 * repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL]; 153 * </code> 154 */ 155 java.util.List<? extends com.google.cloud.vision.v1.BoundingPolyOrBuilder> getBoundingPolysOrBuilderList()156 getBoundingPolysOrBuilderList(); 157 /** 158 * 159 * 160 * <pre> 161 * Optional. Bounding polygons around the areas of interest in the reference image. 162 * If this field is empty, the system will try to detect regions of 163 * interest. At most 10 bounding polygons will be used. 164 * The provided shape is converted into a non-rotated rectangle. Once 165 * converted, the small edge of the rectangle must be greater than or equal 166 * to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 167 * is not). 168 * </pre> 169 * 170 * <code> 171 * repeated .google.cloud.vision.v1.BoundingPoly bounding_polys = 3 [(.google.api.field_behavior) = OPTIONAL]; 172 * </code> 173 */ getBoundingPolysOrBuilder(int index)174 com.google.cloud.vision.v1.BoundingPolyOrBuilder getBoundingPolysOrBuilder(int index); 175 } 176