Package org.mlflow.api.proto

Class Service.ListArtifacts.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

org.mlflow.api.proto.Service.ListArtifacts.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Service.ListArtifactsOrBuilder

Enclosing class:

Service.ListArtifacts

public static final class Service.ListArtifacts.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>
implements Service.ListArtifactsOrBuilder

Protobuf type mlflow.ListArtifacts

Method Summary

Modifier and Type	Method	Description
Service.ListArtifacts.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.ListArtifacts	build()
Service.ListArtifacts	buildPartial()
Service.ListArtifacts.Builder	clear()
Service.ListArtifacts.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Service.ListArtifacts.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Service.ListArtifacts.Builder	clearPageToken()	Token indicating the page of artifact results to fetch
Service.ListArtifacts.Builder	clearPath()	Filter artifacts matching this path (a relative path from the root artifact directory).
Service.ListArtifacts.Builder	clearRunId()	ID of the run whose artifacts to list.
Service.ListArtifacts.Builder	clearRunUuid()	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
Service.ListArtifacts.Builder	clone()
Service.ListArtifacts	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getPageToken()	Token indicating the page of artifact results to fetch
com.google.protobuf.ByteString	getPageTokenBytes()	Token indicating the page of artifact results to fetch
String	getPath()	Filter artifacts matching this path (a relative path from the root artifact directory).
com.google.protobuf.ByteString	getPathBytes()	Filter artifacts matching this path (a relative path from the root artifact directory).
String	getRunId()	ID of the run whose artifacts to list.
com.google.protobuf.ByteString	getRunIdBytes()	ID of the run whose artifacts to list.
String	getRunUuid()	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
com.google.protobuf.ByteString	getRunUuidBytes()	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
boolean	hasPageToken()	Token indicating the page of artifact results to fetch
boolean	hasPath()	Filter artifacts matching this path (a relative path from the root artifact directory).
boolean	hasRunId()	ID of the run whose artifacts to list.
boolean	hasRunUuid()	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Service.ListArtifacts.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Service.ListArtifacts.Builder	mergeFrom(com.google.protobuf.Message other)
Service.ListArtifacts.Builder	mergeFrom(Service.ListArtifacts other)
final Service.ListArtifacts.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Service.ListArtifacts.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.ListArtifacts.Builder	setPageToken(String value)	Token indicating the page of artifact results to fetch
Service.ListArtifacts.Builder	setPageTokenBytes(com.google.protobuf.ByteString value)	Token indicating the page of artifact results to fetch
Service.ListArtifacts.Builder	setPath(String value)	Filter artifacts matching this path (a relative path from the root artifact directory).
Service.ListArtifacts.Builder	setPathBytes(com.google.protobuf.ByteString value)	Filter artifacts matching this path (a relative path from the root artifact directory).
Service.ListArtifacts.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Service.ListArtifacts.Builder	setRunId(String value)	ID of the run whose artifacts to list.
Service.ListArtifacts.Builder	setRunIdBytes(com.google.protobuf.ByteString value)	ID of the run whose artifacts to list.
Service.ListArtifacts.Builder	setRunUuid(String value)	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
Service.ListArtifacts.Builder	setRunUuidBytes(com.google.protobuf.ByteString value)	[Deprecated, use run_id instead] ID of the run whose artifacts to list.
final Service.ListArtifacts.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

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.Builder<Service.ListArtifacts.Builder>

clear

public Service.ListArtifacts.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

getDefaultInstanceForType

public Service.ListArtifacts getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Service.ListArtifacts build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Service.ListArtifacts buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Service.ListArtifacts.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

setField

public Service.ListArtifacts.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

clearField

public Service.ListArtifacts.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

clearOneof

public Service.ListArtifacts.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

setRepeatedField

public Service.ListArtifacts.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

addRepeatedField

public Service.ListArtifacts.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

mergeFrom

public Service.ListArtifacts.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.ListArtifacts.Builder>

mergeFrom

public Service.ListArtifacts.Builder mergeFrom(Service.ListArtifacts other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

mergeFrom

public Service.ListArtifacts.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.ListArtifacts.Builder>

Throws:

IOException

hasRunId

public boolean hasRunId()

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Specified by:

hasRunId in interface Service.ListArtifactsOrBuilder

Returns:

Whether the runId field is set.

getRunId

public String getRunId()

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Specified by:

getRunId in interface Service.ListArtifactsOrBuilder

Returns:

The runId.

getRunIdBytes

public com.google.protobuf.ByteString getRunIdBytes()

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Specified by:

getRunIdBytes in interface Service.ListArtifactsOrBuilder

Returns:

The bytes for runId.

setRunId

public Service.ListArtifacts.Builder setRunId(String value)

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Parameters:

value - The runId to set.

Returns:

This builder for chaining.

clearRunId

public Service.ListArtifacts.Builder clearRunId()

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Returns:

This builder for chaining.

setRunIdBytes

public Service.ListArtifacts.Builder setRunIdBytes(com.google.protobuf.ByteString value)

 ID of the run whose artifacts to list. Must be provided.
 

optional string run_id = 3;

Parameters:

value - The bytes for runId to set.

Returns:

This builder for chaining.

hasRunUuid

public boolean hasRunUuid()

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

hasRunUuid in interface Service.ListArtifactsOrBuilder

Returns:

Whether the runUuid field is set.

getRunUuid

public String getRunUuid()

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

getRunUuid in interface Service.ListArtifactsOrBuilder

Returns:

The runUuid.

getRunUuidBytes

public com.google.protobuf.ByteString getRunUuidBytes()

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

getRunUuidBytes in interface Service.ListArtifactsOrBuilder

Returns:

The bytes for runUuid.

setRunUuid

public Service.ListArtifacts.Builder setRunUuid(String value)

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Parameters:

value - The runUuid to set.

Returns:

This builder for chaining.

clearRunUuid

public Service.ListArtifacts.Builder clearRunUuid()

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Returns:

This builder for chaining.

setRunUuidBytes

public Service.ListArtifacts.Builder setRunUuidBytes(com.google.protobuf.ByteString value)

 [Deprecated, use run_id instead] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Parameters:

value - The bytes for runUuid to set.

Returns:

This builder for chaining.

hasPath

public boolean hasPath()

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Specified by:

hasPath in interface Service.ListArtifactsOrBuilder

Returns:

Whether the path field is set.

getPath

public String getPath()

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Specified by:

getPath in interface Service.ListArtifactsOrBuilder

Returns:

The path.

getPathBytes

public com.google.protobuf.ByteString getPathBytes()

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Specified by:

getPathBytes in interface Service.ListArtifactsOrBuilder

Returns:

The bytes for path.

setPath

public Service.ListArtifacts.Builder setPath(String value)

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Parameters:

value - The path to set.

Returns:

This builder for chaining.

clearPath

public Service.ListArtifacts.Builder clearPath()

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Returns:

This builder for chaining.

setPathBytes

public Service.ListArtifacts.Builder setPathBytes(com.google.protobuf.ByteString value)

 Filter artifacts matching this path (a relative path from the root artifact directory).
 

optional string path = 2;

Parameters:

value - The bytes for path to set.

Returns:

This builder for chaining.

hasPageToken

public boolean hasPageToken()

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Specified by:

hasPageToken in interface Service.ListArtifactsOrBuilder

Returns:

Whether the pageToken field is set.

getPageToken

public String getPageToken()

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Specified by:

getPageToken in interface Service.ListArtifactsOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Specified by:

getPageTokenBytes in interface Service.ListArtifactsOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public Service.ListArtifacts.Builder setPageToken(String value)

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public Service.ListArtifacts.Builder clearPageToken()

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

public Service.ListArtifacts.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 Token indicating the page of artifact results to fetch
 

optional string page_token = 4;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final Service.ListArtifacts.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>

mergeUnknownFields

public final Service.ListArtifacts.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.ListArtifacts.Builder>