Class CreateAnalysisRequest (0.12.0)

public final class CreateAnalysisRequest extends GeneratedMessageV3 implements CreateAnalysisRequestOrBuilder

Message for creating an Analysis.

Protobuf type google.cloud.visionai.v1.CreateAnalysisRequest

Static Fields

ANALYSIS_FIELD_NUMBER

public static final int ANALYSIS_FIELD_NUMBER
Field Value
Type Description
int

ANALYSIS_ID_FIELD_NUMBER

public static final int ANALYSIS_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateAnalysisRequest getDefaultInstance()
Returns
Type Description
CreateAnalysisRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateAnalysisRequest.Builder newBuilder()
Returns
Type Description
CreateAnalysisRequest.Builder

newBuilder(CreateAnalysisRequest prototype)

public static CreateAnalysisRequest.Builder newBuilder(CreateAnalysisRequest prototype)
Parameter
Name Description
prototype CreateAnalysisRequest
Returns
Type Description
CreateAnalysisRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateAnalysisRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateAnalysisRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateAnalysisRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateAnalysisRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateAnalysisRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateAnalysisRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateAnalysisRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateAnalysisRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateAnalysisRequest> parser()
Returns
Type Description
Parser<CreateAnalysisRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnalysis()

public Analysis getAnalysis()

Required. The resource being created.

.google.cloud.visionai.v1.Analysis analysis = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Analysis

The analysis.

getAnalysisId()

public String getAnalysisId()

Required. Id of the requesting object.

string analysis_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The analysisId.

getAnalysisIdBytes()

public ByteString getAnalysisIdBytes()

Required. Id of the requesting object.

string analysis_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for analysisId.

getAnalysisOrBuilder()

public AnalysisOrBuilder getAnalysisOrBuilder()

Required. The resource being created.

.google.cloud.visionai.v1.Analysis analysis = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AnalysisOrBuilder

getDefaultInstanceForType()

public CreateAnalysisRequest getDefaultInstanceForType()
Returns
Type Description
CreateAnalysisRequest

getParent()

public String getParent()

Required. Value for parent.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Value for parent.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateAnalysisRequest> getParserForType()
Returns
Type Description
Parser<CreateAnalysisRequest>
Overrides

getRequestId()

public String getRequestId()

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_behavior) = OPTIONAL];

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

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_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAnalysis()

public boolean hasAnalysis()

Required. The resource being created.

.google.cloud.visionai.v1.Analysis analysis = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the analysis field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateAnalysisRequest.Builder newBuilderForType()
Returns
Type Description
CreateAnalysisRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateAnalysisRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateAnalysisRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateAnalysisRequest.Builder toBuilder()
Returns
Type Description
CreateAnalysisRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException