Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.TensorboardsResource

The "tensorboards" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.TensorboardsResource
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

Constructors

TensorboardsResource(IClientService)

Constructs a new resource.

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

Properties

Experiments

Gets the Experiments resource.

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

Operations

Gets the Operations resource.

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

Methods

BatchRead(string)

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.BatchReadRequest BatchRead(string tensorboard)
Parameters
Type Name Description
string tensorboard

Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.BatchReadRequest

Create(GoogleCloudAiplatformV1Tensorboard, string)

Creates a Tensorboard.

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

The body of the request.

string parent

Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.CreateRequest

Delete(string)

Deletes a Tensorboard.

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

Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.DeleteRequest

Get(string)

Gets a Tensorboard.

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

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.GetRequest

List(string)

Lists Tensorboards in a Location.

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

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ListRequest

Patch(GoogleCloudAiplatformV1Tensorboard, string)

Updates a Tensorboard.

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

The body of the request.

string name

Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.PatchRequest

ReadSize(string)

Returns the storage size for a given TensorBoard instance.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ReadSizeRequest ReadSize(string tensorboard)
Parameters
Type Name Description
string tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type Description
ProjectsResource.LocationsResource.TensorboardsResource.ReadSizeRequest

ReadUsage(string)

Returns a list of monthly active users for a given TensorBoard instance.

Declaration
public virtual ProjectsResource.LocationsResource.TensorboardsResource.ReadUsageRequest ReadUsage(string tensorboard)
Parameters
Type Name Description
string tensorboard

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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