public final class ListTensorboardRunsRequest extends GeneratedMessageV3 implements ListTensorboardRunsRequestOrBuilder
Request message for TensorboardService.ListTensorboardRuns.
Protobuf type google.cloud.aiplatform.v1.ListTensorboardRunsRequest
Fields
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
public static final int READ_MASK_FIELD_NUMBER
Field Value
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public static ListTensorboardRunsRequest getDefaultInstance()
Returns
public ListTensorboardRunsRequest getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public String getFilter()
Lists the TensorboardRuns that match the filter expression.
string filter = 2;
| Type | Description |
| String | The filter.
|
public ByteString getFilterBytes()
Lists the TensorboardRuns that match the filter expression.
string filter = 2;
public String getOrderBy()
Field to use to sort the list.
string order_by = 5;
| Type | Description |
| String | The orderBy.
|
public ByteString getOrderByBytes()
Field to use to sort the list.
string order_by = 5;
getPageSize()
The maximum number of TensorboardRuns to return. The service may return
fewer than this value. If unspecified, at most 50 TensorboardRuns will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
int32 page_size = 3;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token, received from a previous
TensorboardService.ListTensorboardRuns call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
TensorboardService.ListTensorboardRuns must
match the call that provided the page token.
string page_token = 4;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous
TensorboardService.ListTensorboardRuns call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
TensorboardService.ListTensorboardRuns must
match the call that provided the page token.
string page_token = 4;
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) = { ... }
| Type | Description |
| String | The parent.
|
public 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) = { ... }
public Parser<ListTensorboardRunsRequest> getParserForType()
Returns
Overrides
public FieldMask getReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
public FieldMaskOrBuilder getReadMaskOrBuilder()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
| Type | Description |
| boolean | Whether the readMask field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static ListTensorboardRunsRequest.Builder newBuilder()
Returns
public static ListTensorboardRunsRequest.Builder newBuilder(ListTensorboardRunsRequest prototype)
Parameter
Returns
public ListTensorboardRunsRequest.Builder newBuilderForType()
Returns
protected ListTensorboardRunsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListTensorboardRunsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTensorboardRunsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListTensorboardRunsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListTensorboardRunsRequest> parser()
Returns
public ListTensorboardRunsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
