Class CreateModelRequest (2.49.0) 

public final class CreateModelRequest extends GeneratedMessageV3 implements CreateModelRequestOrBuilder

Request for creating a model.

Protobuf type google.cloud.retail.v2.CreateModelRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateModelRequest

Static Fields

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateModelRequest getDefaultInstance()
Returns
Type Description
CreateModelRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateModelRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateModelRequest getDefaultInstanceForType()
Returns
Type Description
CreateModelRequest

getDryRun()

public boolean getDryRun()

Optional. Whether to run a dry run to validate the request (without actually creating the model).

bool dry_run = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The dryRun.

getModel()

public Model getModel()

Required. The payload of the Model to create.

.google.cloud.retail.v2.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Model

The model.

getModelOrBuilder()

public ModelOrBuilder getModelOrBuilder()

Required. The payload of the Model to create.

.google.cloud.retail.v2.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ModelOrBuilder

getParent()

public String getParent()

Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasModel()

public boolean hasModel()

Required. The payload of the Model to create.

.google.cloud.retail.v2.Model model = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the model 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 CreateModelRequest.Builder newBuilderForType()
Returns
Type Description
CreateModelRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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