Class: Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest

Inherits:

Object

• Object
• Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb

Overview

Request message for TensorboardService.ListTensorboardRuns.

Instance Attribute Summary

• #filter ⇒ ::String

  Lists the TensorboardRuns that match the filter expression.

• #order_by ⇒ ::String

  Field to use to sort the list.

• #page_size ⇒ ::Integer

  The maximum number of TensorboardRuns to return.

• #page_token ⇒ ::String

  A page token, received from a previous TensorboardService.ListTensorboardRuns call.

• #parent ⇒ ::String

  Required.

• #read_mask ⇒ ::Google::Protobuf::FieldMask

  Mask specifying which fields to read.

Instance Attribute Details

#filter ⇒ ::String

Returns Lists the TensorboardRuns that match the filter expression.

Returns:

• (::String) —

  Lists the TensorboardRuns that match the filter expression.

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Field to use to sort the list.

Returns:

• (::String) —

  Field to use to sort the list.

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::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.

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Mask specifying which fields to read.

Returns:

• (::Google::Protobuf::FieldMask) —

  Mask specifying which fields to read.

# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb', line 349

class ListTensorboardRunsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end