- 1.33.0 (latest)
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListTensorboardExperimentsRequest.
Request message for TensorboardService.ListTensorboardExperiments.
Generated from protobuf message google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: |
↳ filter |
string
Lists the TensorboardExperiments that match the filter expression. |
↳ page_size |
int
The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. |
↳ order_by |
string
Field to use to sort the list. |
↳ read_mask |
Google\Protobuf\FieldMask
Mask specifying which fields to read. |
getParent
Required. The resource name of the Tensorboard to list TensorboardExperiments.
Format:
projects/{project}/locations/{___location}/tensorboards/{tensorboard}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the Tensorboard to list TensorboardExperiments.
Format:
projects/{project}/locations/{___location}/tensorboards/{tensorboard}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Lists the TensorboardExperiments that match the filter expression.
Generated from protobuf field string filter = 2;
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Lists the TensorboardExperiments that match the filter expression.
Generated from protobuf field string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Generated from protobuf field int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A page token, received from a previous TensorboardService.ListTensorboardExperiments call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, received from a previous TensorboardService.ListTensorboardExperiments call.
Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.
Generated from protobuf field string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Field to use to sort the list.
Generated from protobuf field string order_by = 5;
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Field to use to sort the list.
Generated from protobuf field string order_by = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasReadMask
clearReadMask
setReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|