Class ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource | Google.Apis.Aiplatform.v1
Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource

The "runs" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource

Constructors

RunsResource(IClientService)

Constructs a new resource.

Declaration
public RunsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource

TimeSeries

Gets the TimeSeries resource.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource TimeSeries { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource

Methods

BatchCreate(GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest, string)

Batch create TensorboardRuns.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.BatchCreateRequest BatchCreate(GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest body

The body of the request.

string parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.BatchCreateRequest

Create(GoogleCloudAiplatformV1TensorboardRun, string)

Creates a TensorboardRun.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.CreateRequest Create(GoogleCloudAiplatformV1TensorboardRun body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1TensorboardRun body

The body of the request.

string parent

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.CreateRequest

Delete(string)

Deletes a TensorboardRun.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.DeleteRequest

Get(string)

Gets a TensorboardRun.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.GetRequest

List(string)

Lists TensorboardRuns in a Location.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.ListRequest

Patch(GoogleCloudAiplatformV1TensorboardRun, string)

Updates a TensorboardRun.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.PatchRequest Patch(GoogleCloudAiplatformV1TensorboardRun body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1TensorboardRun body

The body of the request.

string name

Output only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.PatchRequest

Write(GoogleCloudAiplatformV1WriteTensorboardRunDataRequest, string)

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.WriteRequest Write(GoogleCloudAiplatformV1WriteTensorboardRunDataRequest body, string tensorboardRun)
Parameters
Type Name Description
GoogleCloudAiplatformV1WriteTensorboardRunDataRequest body

The body of the request.

string tensorboardRun

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.WriteRequest
In this article
Back to top Generated by DocFX