Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest.
Request message for TensorboardService.ListTensorboardRuns.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
- (::String) — Lists the TensorboardRuns that match the filter expression.
#filter=
def filter=(value) -> ::String
Parameter
- value (::String) — Lists the TensorboardRuns that match the filter expression.
Returns
- (::String) — Lists the TensorboardRuns that match the filter expression.
#order_by
def order_by() -> ::String
Returns
- (::String) — Field to use to sort the list.
#order_by=
def order_by=(value) -> ::String
Parameter
- value (::String) — Field to use to sort the list.
Returns
- (::String) — Field to use to sort the list.
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — 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.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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.
#page_token
def page_token() -> ::String
Returns
-
(::String) — 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.
#page_token=
def page_token=(value) -> ::String
Parameter
-
value (::String) — 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.
Returns
-
(::String) — 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.
#parent
def parent() -> ::String
Returns
- (::String) — Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'
#parent=
def parent=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'
Returns
- (::String) — Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'
#read_mask
def read_mask() -> ::Google::Protobuf::FieldMask
Returns
- (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.
#read_mask=
def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
- value (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.
Returns
- (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.