Class PublisherModel (3.50.0)

public final class PublisherModel extends GeneratedMessageV3 implements PublisherModelOrBuilder

A Model Garden Publisher Model.

Protobuf type google.cloud.aiplatform.v1.PublisherModel

Static Fields

FRAMEWORKS_FIELD_NUMBER

public static final int FRAMEWORKS_FIELD_NUMBER
Field Value
Type Description
int

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPEN_SOURCE_CATEGORY_FIELD_NUMBER

public static final int OPEN_SOURCE_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

PREDICT_SCHEMATA_FIELD_NUMBER

public static final int PREDICT_SCHEMATA_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHER_MODEL_TEMPLATE_FIELD_NUMBER

public static final int PUBLISHER_MODEL_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_ACTIONS_FIELD_NUMBER

public static final int SUPPORTED_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

VERSION_ID_FIELD_NUMBER

public static final int VERSION_ID_FIELD_NUMBER
Field Value
Type Description
int

VERSION_STATE_FIELD_NUMBER

public static final int VERSION_STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PublisherModel getDefaultInstance()
Returns
Type Description
PublisherModel

getDescriptor()

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

newBuilder()

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

newBuilder(PublisherModel prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PublisherModel getDefaultInstanceForType()
Returns
Type Description
PublisherModel

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for openSourceCategory.

getParserForType()

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

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
Type Description
PredictSchemata

The predictSchemata.

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for publisherModelTemplate.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Type Description
PublisherModel.CallToAction

The supportedActions.

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for versionId.

getVersionState()

public PublisherModel.VersionState getVersionState()

Optional. Indicates the state of the model version.

.google.cloud.aiplatform.v1.PublisherModel.VersionState version_state = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublisherModel.VersionState

The versionState.

getVersionStateValue()

public int getVersionStateValue()

Optional. Indicates the state of the model version.

.google.cloud.aiplatform.v1.PublisherModel.VersionState version_state = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for versionState.

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
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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