com.google.cloud.aiplatform.v1beta1

Class ListHyperparameterTuningJobsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest

All Implemented Interfaces:

ListHyperparameterTuningJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ListHyperparameterTuningJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListHyperparameterTuningJobsRequestOrBuilder

 Request message for
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs].
 

Protobuf type google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListHyperparameterTuningJobsRequest.Builder Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	READ_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListHyperparameterTuningJobsRequest	getDefaultInstance()
ListHyperparameterTuningJobsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() The standard list filter.
com.google.protobuf.ByteString	getFilterBytes() The standard list filter.
int	getPageSize() The standard list page size.
String	getPageToken() The standard list page token.
com.google.protobuf.ByteString	getPageTokenBytes() The standard list page token.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ListHyperparameterTuningJobsRequest>	getParserForType()
com.google.protobuf.FieldMask	getReadMask() Mask specifying which fields to read.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() Mask specifying which fields to read.
int	getSerializedSize()
int	hashCode()
boolean	hasReadMask() Mask specifying which fields to read.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListHyperparameterTuningJobsRequest.Builder	newBuilder()
static ListHyperparameterTuningJobsRequest.Builder	newBuilder(ListHyperparameterTuningJobsRequest prototype)
ListHyperparameterTuningJobsRequest.Builder	newBuilderForType()
protected ListHyperparameterTuningJobsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListHyperparameterTuningJobsRequest	parseDelimitedFrom(InputStream input)
static ListHyperparameterTuningJobsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListHyperparameterTuningJobsRequest	parseFrom(byte[] data)
static ListHyperparameterTuningJobsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListHyperparameterTuningJobsRequest	parseFrom(ByteBuffer data)
static ListHyperparameterTuningJobsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListHyperparameterTuningJobsRequest	parseFrom(com.google.protobuf.ByteString data)
static ListHyperparameterTuningJobsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListHyperparameterTuningJobsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListHyperparameterTuningJobsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListHyperparameterTuningJobsRequest	parseFrom(InputStream input)
static ListHyperparameterTuningJobsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListHyperparameterTuningJobsRequest>	parser()
ListHyperparameterTuningJobsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_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

getParent

public String getParent()

 Required. The resource name of the Location to list the
 HyperparameterTuningJobs from. Format:
 `projects/{project}/locations/{location}`
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The resource name of the Location to list the
 HyperparameterTuningJobs from. Format:
 `projects/{project}/locations/{location}`
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The bytes for parent.

getFilter

public String getFilter()

 The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
 

string filter = 2;

Specified by:

getFilter in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
 

string filter = 2;

Specified by:

getFilterBytes in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The bytes for filter.

getPageSize

public int getPageSize()

 The standard list page size.
 

int32 page_size = 3;

Specified by:

getPageSize in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The pageSize.

getPageToken

public String getPageToken()

 The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
 call.
 

string page_token = 4;

Specified by:

getPageToken in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]
 call.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The bytes for pageToken.

hasReadMask

public boolean hasReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

Specified by:

hasReadMask in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

Whether the readMask field is set.

getReadMask

public com.google.protobuf.FieldMask getReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

Specified by:

getReadMask in interface ListHyperparameterTuningJobsRequestOrBuilder

Returns:

The readMask.

getReadMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 5;

Specified by:

getReadMaskOrBuilder in interface ListHyperparameterTuningJobsRequestOrBuilder

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 ListHyperparameterTuningJobsRequest parseFrom(ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(com.google.protobuf.ByteString data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(com.google.protobuf.ByteString data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(byte[] data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListHyperparameterTuningJobsRequest parseDelimitedFrom(InputStream input)
                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListHyperparameterTuningJobsRequest parseDelimitedFrom(InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Throws:

IOException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static ListHyperparameterTuningJobsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

newBuilderForType

public ListHyperparameterTuningJobsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListHyperparameterTuningJobsRequest.Builder newBuilder()

newBuilder

public static ListHyperparameterTuningJobsRequest.Builder newBuilder(ListHyperparameterTuningJobsRequest prototype)

toBuilder

public ListHyperparameterTuningJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListHyperparameterTuningJobsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListHyperparameterTuningJobsRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ListHyperparameterTuningJobsRequest> 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 ListHyperparameterTuningJobsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder