Class ExplanationSpec (1.11.0)

public final class ExplanationSpec extends GeneratedMessageV3 implements ExplanationSpecOrBuilder

Specification of Model explanation.

Protobuf type google.cloud.vertexai.v1.ExplanationSpec

Static Fields

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplanationSpec getDefaultInstance()
Returns
Type Description
ExplanationSpec

getDescriptor()

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

newBuilder()

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

newBuilder(ExplanationSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExplanationSpec getDefaultInstanceForType()
Returns
Type Description
ExplanationSpec

getMetadata()

public ExplanationMetadata getMetadata()

Optional. Metadata describing the Model's input and output for explanation.

.google.cloud.vertexai.v1.ExplanationMetadata metadata = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplanationMetadata

The metadata.

getMetadataOrBuilder()

public ExplanationMetadataOrBuilder getMetadataOrBuilder()

Optional. Metadata describing the Model's input and output for explanation.

.google.cloud.vertexai.v1.ExplanationMetadata metadata = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExplanationMetadataOrBuilder

getParameters()

public ExplanationParameters getParameters()

Required. Parameters that configure explaining of the Model's predictions.

.google.cloud.vertexai.v1.ExplanationParameters parameters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExplanationParameters

The parameters.

getParametersOrBuilder()

public ExplanationParametersOrBuilder getParametersOrBuilder()

Required. Parameters that configure explaining of the Model's predictions.

.google.cloud.vertexai.v1.ExplanationParameters parameters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExplanationParametersOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Optional. Metadata describing the Model's input and output for explanation.

.google.cloud.vertexai.v1.ExplanationMetadata metadata = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metadata field is set.

hasParameters()

public boolean hasParameters()

Required. Parameters that configure explaining of the Model's predictions.

.google.cloud.vertexai.v1.ExplanationParameters parameters = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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