Class PublisherModel.Builder (3.20.0)

public static final class PublisherModel.Builder extends GeneratedMessageV3.Builder<PublisherModel.Builder> implements PublisherModelOrBuilder

A Model Garden Publisher Model.

Protobuf type google.cloud.aiplatform.v1.PublisherModel

Static Methods

getDescriptor()

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

Methods

addAllFrameworks(Iterable<String> values)

public PublisherModel.Builder addAllFrameworks(Iterable<String> values)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<String>

The frameworks to add.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

addFrameworks(String value)

public PublisherModel.Builder addFrameworks(String value)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The frameworks to add.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

addFrameworksBytes(ByteString value)

public PublisherModel.Builder addFrameworksBytes(ByteString value)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes of the frameworks to add.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PublisherModel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PublisherModel.Builder
Overrides

build()

public PublisherModel build()
Returns
TypeDescription
PublisherModel

buildPartial()

public PublisherModel buildPartial()
Returns
TypeDescription
PublisherModel

clear()

public PublisherModel.Builder clear()
Returns
TypeDescription
PublisherModel.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PublisherModel.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PublisherModel.Builder
Overrides

clearFrameworks()

public PublisherModel.Builder clearFrameworks()

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clearLaunchStage()

public PublisherModel.Builder clearLaunchStage()

Optional. Indicates the launch stage of the model.

.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clearName()

public PublisherModel.Builder clearName()

Output only. The resource name of the PublisherModel.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PublisherModel.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PublisherModel.Builder
Overrides

clearOpenSourceCategory()

public PublisherModel.Builder clearOpenSourceCategory()

Required. Indicates the open source category of the publisher model.

.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clearPredictSchemata()

public PublisherModel.Builder clearPredictSchemata()

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.Builder

clearPublisherModelTemplate()

public PublisherModel.Builder clearPublisherModelTemplate()

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clearSupportedActions()

public PublisherModel.Builder clearSupportedActions()

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.Builder

clearVersionId()

public PublisherModel.Builder clearVersionId()

Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

clone()

public PublisherModel.Builder clone()
Returns
TypeDescription
PublisherModel.Builder
Overrides

getDefaultInstanceForType()

public PublisherModel getDefaultInstanceForType()
Returns
TypeDescription
PublisherModel

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFrameworks(int index)

public String getFrameworks(int index)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The frameworks at the given index.

getFrameworksBytes(int index)

public ByteString getFrameworksBytes(int index)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the frameworks at the given index.

getFrameworksCount()

public int getFrameworksCount()

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of frameworks.

getFrameworksList()

public ProtocolStringList getFrameworksList()

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the frameworks.

getLaunchStage()

public PublisherModel.LaunchStage getLaunchStage()

Optional. Indicates the launch stage of the model.

.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.LaunchStage

The launchStage.

getLaunchStageValue()

public int getLaunchStageValue()

Optional. Indicates the launch stage of the model.

.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for launchStage.

getName()

public String getName()

Output only. The resource name of the PublisherModel.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the PublisherModel.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getOpenSourceCategory()

public PublisherModel.OpenSourceCategory getOpenSourceCategory()

Required. Indicates the open source category of the publisher model.

.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PublisherModel.OpenSourceCategory

The openSourceCategory.

getOpenSourceCategoryValue()

public int getOpenSourceCategoryValue()

Required. Indicates the open source category of the publisher model.

.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for openSourceCategory.

getPredictSchemata()

public PredictSchemata getPredictSchemata()

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PredictSchemata

The predictSchemata.

getPredictSchemataBuilder()

public PredictSchemata.Builder getPredictSchemataBuilder()

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PredictSchemata.Builder

getPredictSchemataOrBuilder()

public PredictSchemataOrBuilder getPredictSchemataOrBuilder()

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PredictSchemataOrBuilder

getPublisherModelTemplate()

public String getPublisherModelTemplate()

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The publisherModelTemplate.

getPublisherModelTemplateBytes()

public ByteString getPublisherModelTemplateBytes()

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for publisherModelTemplate.

getSupportedActions()

public PublisherModel.CallToAction getSupportedActions()

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.CallToAction

The supportedActions.

getSupportedActionsBuilder()

public PublisherModel.CallToAction.Builder getSupportedActionsBuilder()

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.CallToAction.Builder

getSupportedActionsOrBuilder()

public PublisherModel.CallToActionOrBuilder getSupportedActionsOrBuilder()

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PublisherModel.CallToActionOrBuilder

getVersionId()

public String getVersionId()

Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The versionId.

getVersionIdBytes()

public ByteString getVersionIdBytes()

Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for versionId.

hasPredictSchemata()

public boolean hasPredictSchemata()

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the predictSchemata field is set.

hasSupportedActions()

public boolean hasSupportedActions()

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the supportedActions field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PublisherModel other)

public PublisherModel.Builder mergeFrom(PublisherModel other)
Parameter
NameDescription
otherPublisherModel
Returns
TypeDescription
PublisherModel.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PublisherModel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PublisherModel.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PublisherModel.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PublisherModel.Builder
Overrides

mergePredictSchemata(PredictSchemata value)

public PublisherModel.Builder mergePredictSchemata(PredictSchemata value)

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePredictSchemata
Returns
TypeDescription
PublisherModel.Builder

mergeSupportedActions(PublisherModel.CallToAction value)

public PublisherModel.Builder mergeSupportedActions(PublisherModel.CallToAction value)

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePublisherModel.CallToAction
Returns
TypeDescription
PublisherModel.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PublisherModel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PublisherModel.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PublisherModel.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PublisherModel.Builder
Overrides

setFrameworks(int index, String value)

public PublisherModel.Builder setFrameworks(int index, String value)

Optional. Additional information about the model's Frameworks.

repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The frameworks to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setLaunchStage(PublisherModel.LaunchStage value)

public PublisherModel.Builder setLaunchStage(PublisherModel.LaunchStage value)

Optional. Indicates the launch stage of the model.

.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePublisherModel.LaunchStage

The launchStage to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setLaunchStageValue(int value)

public PublisherModel.Builder setLaunchStageValue(int value)

Optional. Indicates the launch stage of the model.

.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The enum numeric value on the wire for launchStage to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setName(String value)

public PublisherModel.Builder setName(String value)

Output only. The resource name of the PublisherModel.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PublisherModel.Builder setNameBytes(ByteString value)

Output only. The resource name of the PublisherModel.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setOpenSourceCategory(PublisherModel.OpenSourceCategory value)

public PublisherModel.Builder setOpenSourceCategory(PublisherModel.OpenSourceCategory value)

Required. Indicates the open source category of the publisher model.

.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuePublisherModel.OpenSourceCategory

The openSourceCategory to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setOpenSourceCategoryValue(int value)

public PublisherModel.Builder setOpenSourceCategoryValue(int value)

Required. Indicates the open source category of the publisher model.

.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

The enum numeric value on the wire for openSourceCategory to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setPredictSchemata(PredictSchemata value)

public PublisherModel.Builder setPredictSchemata(PredictSchemata value)

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePredictSchemata
Returns
TypeDescription
PublisherModel.Builder

setPredictSchemata(PredictSchemata.Builder builderForValue)

public PublisherModel.Builder setPredictSchemata(PredictSchemata.Builder builderForValue)

Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValuePredictSchemata.Builder
Returns
TypeDescription
PublisherModel.Builder

setPublisherModelTemplate(String value)

public PublisherModel.Builder setPublisherModelTemplate(String value)

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The publisherModelTemplate to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setPublisherModelTemplateBytes(ByteString value)

public PublisherModel.Builder setPublisherModelTemplateBytes(ByteString value)

Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for publisherModelTemplate to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PublisherModel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PublisherModel.Builder
Overrides

setSupportedActions(PublisherModel.CallToAction value)

public PublisherModel.Builder setSupportedActions(PublisherModel.CallToAction value)

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuePublisherModel.CallToAction
Returns
TypeDescription
PublisherModel.Builder

setSupportedActions(PublisherModel.CallToAction.Builder builderForValue)

public PublisherModel.Builder setSupportedActions(PublisherModel.CallToAction.Builder builderForValue)

Optional. Supported call-to-action options.

.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValuePublisherModel.CallToAction.Builder
Returns
TypeDescription
PublisherModel.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PublisherModel.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PublisherModel.Builder
Overrides

setVersionId(String value)

public PublisherModel.Builder setVersionId(String value)

Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The versionId to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.

setVersionIdBytes(ByteString value)

public PublisherModel.Builder setVersionIdBytes(ByteString value)

Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for versionId to set.

Returns
TypeDescription
PublisherModel.Builder

This builder for chaining.