Package com.google.cloud.aiplatform.v1

Class PublisherModel

  • All Implemented Interfaces:
    PublisherModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PublisherModel
extends com.google.protobuf.GeneratedMessageV3
implements PublisherModelOrBuilder
     A Model Garden Publisher Model.
    Protobuf type google.cloud.aiplatform.v1.PublisherModel
    See Also:
    Serialized Form

    • Field Detail

      • VERSION_ID_FIELD_NUMBER

        public static final int VERSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPEN_SOURCE_CATEGORY_FIELD_NUMBER

        public static final int OPEN_SOURCE_CATEGORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORTED_ACTIONS_FIELD_NUMBER

        public static final int SUPPORTED_ACTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FRAMEWORKS_FIELD_NUMBER

        public static final int FRAMEWORKS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAUNCH_STAGE_FIELD_NUMBER

        public static final int LAUNCH_STAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBLISHER_MODEL_TEMPLATE_FIELD_NUMBER

        public static final int PUBLISHER_MODEL_TEMPLATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREDICT_SCHEMATA_FIELD_NUMBER

        public static final int PREDICT_SCHEMATA_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the PublisherModel.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface PublisherModelOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the PublisherModel.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface PublisherModelOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getVersionId in interface PublisherModelOrBuilder
        Returns:
        The versionId.

      • getVersionIdBytes

        public com.google.protobuf.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];
        Specified by:
        getVersionIdBytes in interface PublisherModelOrBuilder
        Returns:
        The bytes for versionId.

      • 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];
        Specified by:
        getOpenSourceCategoryValue in interface PublisherModelOrBuilder
        Returns:
        The enum numeric value on the wire for openSourceCategory.

      • 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];
        Specified by:
        getOpenSourceCategory in interface PublisherModelOrBuilder
        Returns:
        The openSourceCategory.

      • hasSupportedActions

        public boolean hasSupportedActions()
         Optional. Supported call-to-action options.
        .google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSupportedActions in interface PublisherModelOrBuilder
        Returns:
        Whether the supportedActions field is set.

      • 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];
        Specified by:
        getSupportedActions in interface PublisherModelOrBuilder
        Returns:
        The supportedActions.

      • getFrameworksList

        public com.google.protobuf.ProtocolStringList getFrameworksList()
         Optional. Additional information about the model's Frameworks.
        repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFrameworksList in interface PublisherModelOrBuilder
        Returns:
        A list containing the frameworks.

      • getFrameworksCount

        public int getFrameworksCount()
         Optional. Additional information about the model's Frameworks.
        repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFrameworksCount in interface PublisherModelOrBuilder
        Returns:
        The count of frameworks.

      • getFrameworks

        public String getFrameworks​(int index)
         Optional. Additional information about the model's Frameworks.
        repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFrameworks in interface PublisherModelOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The frameworks at the given index.

      • getFrameworksBytes

        public com.google.protobuf.ByteString getFrameworksBytes​(int index)
         Optional. Additional information about the model's Frameworks.
        repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFrameworksBytes in interface PublisherModelOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the frameworks at the given index.

      • 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];
        Specified by:
        getLaunchStageValue in interface PublisherModelOrBuilder
        Returns:
        The enum numeric value on the wire for launchStage.

      • 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];
        Specified by:
        getLaunchStage in interface PublisherModelOrBuilder
        Returns:
        The launchStage.

      • 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];
        Specified by:
        getPublisherModelTemplate in interface PublisherModelOrBuilder
        Returns:
        The publisherModelTemplate.

      • getPublisherModelTemplateBytes

        public com.google.protobuf.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];
        Specified by:
        getPublisherModelTemplateBytes in interface PublisherModelOrBuilder
        Returns:
        The bytes for publisherModelTemplate.

      • 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.PredictionService.Predict].
        .google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPredictSchemata in interface PublisherModelOrBuilder
        Returns:
        Whether the predictSchemata field is set.

      • 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.PredictionService.Predict].
        .google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPredictSchemata in interface PublisherModelOrBuilder
        Returns:
        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.PredictionService.Predict].
        .google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPredictSchemataOrBuilder in interface PublisherModelOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PublisherModel parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PublisherModel parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PublisherModel.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PublisherModel.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PublisherModel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PublisherModel getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PublisherModel> parser()

      • getParserForType

        public com.google.protobuf.Parser<PublisherModel> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PublisherModel getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder