Class CreateModelRequest.Builder (2.85.0)

public static final class CreateModelRequest.Builder extends GeneratedMessage.Builder<CreateModelRequest.Builder> implements CreateModelRequestOrBuilder

Request for creating a model.

Protobuf type google.cloud.retail.v2.CreateModelRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateModelRequest build()
Returns
Type Description
CreateModelRequest

buildPartial()

public CreateModelRequest buildPartial()
Returns
Type Description
CreateModelRequest

clear()

public CreateModelRequest.Builder clear()
Returns
Type Description
CreateModelRequest.Builder
Overrides

clearDryRun()

public CreateModelRequest.Builder clearDryRun()

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
CreateModelRequest.Builder

This builder for chaining.

clearModel()

public CreateModelRequest.Builder clearModel()

Required. The payload of the Model to create.

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

Returns
Type Description
CreateModelRequest.Builder

clearParent()

public CreateModelRequest.Builder clearParent()

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
CreateModelRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public CreateModelRequest getDefaultInstanceForType()
Returns
Type Description
CreateModelRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getModelBuilder()

public Model.Builder getModelBuilder()

Required. The payload of the Model to create.

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

Returns
Type Description
Model.Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateModelRequest other)

public CreateModelRequest.Builder mergeFrom(CreateModelRequest other)
Parameter
Name Description
other CreateModelRequest
Returns
Type Description
CreateModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateModelRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateModelRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateModelRequest.Builder
Overrides

mergeModel(Model value)

public CreateModelRequest.Builder mergeModel(Model value)

Required. The payload of the Model to create.

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

Parameter
Name Description
value Model
Returns
Type Description
CreateModelRequest.Builder

setDryRun(boolean value)

public CreateModelRequest.Builder setDryRun(boolean value)

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];

Parameter
Name Description
value boolean

The dryRun to set.

Returns
Type Description
CreateModelRequest.Builder

This builder for chaining.

setModel(Model value)

public CreateModelRequest.Builder setModel(Model value)

Required. The payload of the Model to create.

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

Parameter
Name Description
value Model
Returns
Type Description
CreateModelRequest.Builder

setModel(Model.Builder builderForValue)

public CreateModelRequest.Builder setModel(Model.Builder builderForValue)

Required. The payload of the Model to create.

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

Parameter
Name Description
builderForValue Model.Builder
Returns
Type Description
CreateModelRequest.Builder

setParent(String value)

public CreateModelRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateModelRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateModelRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateModelRequest.Builder

This builder for chaining.