Package com.google.cloud.aiplatform.v1

Class ListTensorboardRunsRequest

  • All Implemented Interfaces:
    ListTensorboardRunsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListTensorboardRunsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListTensorboardRunsRequestOrBuilder
     Request message for
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].
    Protobuf type google.cloud.aiplatform.v1.ListTensorboardRunsRequest
    See Also:
    Serialized Form

    • 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 TensorboardExperiment to list
 TensorboardRuns. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the TensorboardExperiment to list
 TensorboardRuns. Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Lists the TensorboardRuns that match the filter expression.
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public int getPageSize()
         The maximum number of TensorboardRuns to return. The service may return
 fewer than this value. If unspecified, at most 50 TensorboardRuns are
 returned. The maximum value is 1000; values above 1000 are coerced to
 1000.
        int32 page_size = 3;
        Specified by:
        getPageSize in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         A page token, received from a previous
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 must match the call that provided the page token.
        string page_token = 4;
        Specified by:
        getPageToken in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]
 must match the call that provided the page token.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • hasReadMask

        public boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;
        Specified by:
        hasReadMask in interface ListTensorboardRunsRequestOrBuilder
        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 = 6;
        Specified by:
        getReadMask in interface ListTensorboardRunsRequestOrBuilder
        Returns:
        The readMask.

      • 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 ListTensorboardRunsRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListTensorboardRunsRequest> 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 ListTensorboardRunsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder