public final class ListTensorboardRunsRequest extends GeneratedMessageV3 implements ListTensorboardRunsRequestOrBuilder
Request message for
TensorboardService.ListTensorboardRuns.
Protobuf type google.cloud.aiplatform.v1.ListTensorboardRunsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static ListTensorboardRunsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListTensorboardRunsRequest.Builder newBuilder()
public static ListTensorboardRunsRequest.Builder newBuilder(ListTensorboardRunsRequest prototype)
public static ListTensorboardRunsRequest parseDelimitedFrom(InputStream input)
public static ListTensorboardRunsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListTensorboardRunsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static ListTensorboardRunsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListTensorboardRunsRequest parseFrom(ByteString data)
public static ListTensorboardRunsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTensorboardRunsRequest parseFrom(CodedInputStream input)
public static ListTensorboardRunsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListTensorboardRunsRequest parseFrom(InputStream input)
public static ListTensorboardRunsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListTensorboardRunsRequest parseFrom(ByteBuffer data)
public static ListTensorboardRunsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListTensorboardRunsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public ListTensorboardRunsRequest getDefaultInstanceForType()
public String getFilter()
Lists the TensorboardRuns that match the filter expression.
string filter = 2;
| Returns |
|---|
| Type | Description |
String | The filter.
|
public ByteString getFilterBytes()
Lists the TensorboardRuns that match the filter expression.
string filter = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
public String getOrderBy()
Field to use to sort the list.
string order_by = 5;
| Returns |
|---|
| Type | Description |
String | The orderBy.
|
public ByteString getOrderByBytes()
Field to use to sort the list.
string order_by = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
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) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
public Parser<ListTensorboardRunsRequest> getParserForType()
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 |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the readMask field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListTensorboardRunsRequest.Builder newBuilderForType()
protected ListTensorboardRunsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public ListTensorboardRunsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
