Class CreateReferenceImageRequest (3.37.0)

public final class CreateReferenceImageRequest extends GeneratedMessageV3 implements CreateReferenceImageRequestOrBuilder

Request message for the CreateReferenceImage method.

Protobuf type google.cloud.vision.v1.CreateReferenceImageRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_IMAGE_FIELD_NUMBER

public static final int REFERENCE_IMAGE_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_IMAGE_ID_FIELD_NUMBER

public static final int REFERENCE_IMAGE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateReferenceImageRequest getDefaultInstance()
Returns
TypeDescription
CreateReferenceImageRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateReferenceImageRequest.Builder newBuilder()
Returns
TypeDescription
CreateReferenceImageRequest.Builder

newBuilder(CreateReferenceImageRequest prototype)

public static CreateReferenceImageRequest.Builder newBuilder(CreateReferenceImageRequest prototype)
Parameter
NameDescription
prototypeCreateReferenceImageRequest
Returns
TypeDescription
CreateReferenceImageRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateReferenceImageRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateReferenceImageRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateReferenceImageRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateReferenceImageRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateReferenceImageRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateReferenceImageRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateReferenceImageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReferenceImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateReferenceImageRequest> parser()
Returns
TypeDescription
Parser<CreateReferenceImageRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateReferenceImageRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateReferenceImageRequest

getParent()

public String getParent()

Required. Resource name of the product in which to create the reference image.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Resource name of the product in which to create the reference image.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateReferenceImageRequest> getParserForType()
Returns
TypeDescription
Parser<CreateReferenceImageRequest>
Overrides

getReferenceImage()

public ReferenceImage getReferenceImage()

Required. The reference image to create. If an image ID is specified, it is ignored.

.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ReferenceImage

The referenceImage.

getReferenceImageId()

public String getReferenceImageId()

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

string reference_image_id = 3;

Returns
TypeDescription
String

The referenceImageId.

getReferenceImageIdBytes()

public ByteString getReferenceImageIdBytes()

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

string reference_image_id = 3;

Returns
TypeDescription
ByteString

The bytes for referenceImageId.

getReferenceImageOrBuilder()

public ReferenceImageOrBuilder getReferenceImageOrBuilder()

Required. The reference image to create. If an image ID is specified, it is ignored.

.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ReferenceImageOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasReferenceImage()

public boolean hasReferenceImage()

Required. The reference image to create. If an image ID is specified, it is ignored.

.google.cloud.vision.v1.ReferenceImage reference_image = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the referenceImage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateReferenceImageRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateReferenceImageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateReferenceImageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateReferenceImageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateReferenceImageRequest.Builder toBuilder()
Returns
TypeDescription
CreateReferenceImageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException