Class CreateModelRequest (2.29.0)

public final class CreateModelRequest extends GeneratedMessageV3 implements CreateModelRequestOrBuilder

Request for creating a model.

Protobuf type google.cloud.retail.v2beta.CreateModelRequest

Static Fields

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateModelRequest getDefaultInstance()
Returns
TypeDescription
CreateModelRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateModelRequest prototype)

public static CreateModelRequest.Builder newBuilder(CreateModelRequest prototype)
Parameter
NameDescription
prototypeCreateModelRequest
Returns
TypeDescription
CreateModelRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateModelRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The dryRun.

getModel()

public Model getModel()

Required. The payload of the Model to create.

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

Returns
TypeDescription
Model

The model.

getModelOrBuilder()

public ModelOrBuilder getModelOrBuilder()

Required. The payload of the Model to create.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasModel()

public boolean hasModel()

Required. The payload of the Model to create.

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

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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