Class CreateTensorboardRunRequest (3.44.0)

public final class CreateTensorboardRunRequest extends GeneratedMessageV3 implements CreateTensorboardRunRequestOrBuilder

Request message for TensorboardService.CreateTensorboardRun.

Protobuf type google.cloud.aiplatform.v1.CreateTensorboardRunRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

TENSORBOARD_RUN_FIELD_NUMBER

public static final int TENSORBOARD_RUN_FIELD_NUMBER
Field Value
Type Description
int

TENSORBOARD_RUN_ID_FIELD_NUMBER

public static final int TENSORBOARD_RUN_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateTensorboardRunRequest getDefaultInstance()
Returns
Type Description
CreateTensorboardRunRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateTensorboardRunRequest.Builder newBuilder()
Returns
Type Description
CreateTensorboardRunRequest.Builder

newBuilder(CreateTensorboardRunRequest prototype)

public static CreateTensorboardRunRequest.Builder newBuilder(CreateTensorboardRunRequest prototype)
Parameter
Name Description
prototype CreateTensorboardRunRequest
Returns
Type Description
CreateTensorboardRunRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateTensorboardRunRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateTensorboardRunRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateTensorboardRunRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateTensorboardRunRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateTensorboardRunRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateTensorboardRunRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateTensorboardRunRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateTensorboardRunRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateTensorboardRunRequest> parser()
Returns
Type Description
Parser<CreateTensorboardRunRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateTensorboardRunRequest getDefaultInstanceForType()
Returns
Type Description
CreateTensorboardRunRequest

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateTensorboardRunRequest> getParserForType()
Returns
Type Description
Parser<CreateTensorboardRunRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTensorboardRun()

public TensorboardRun getTensorboardRun()

Required. The TensorboardRun to create.

.google.cloud.aiplatform.v1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TensorboardRun

The tensorboardRun.

getTensorboardRunId()

public String getTensorboardRunId()

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /a-z-/.

string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The tensorboardRunId.

getTensorboardRunIdBytes()

public ByteString getTensorboardRunIdBytes()

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /a-z-/.

string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for tensorboardRunId.

getTensorboardRunOrBuilder()

public TensorboardRunOrBuilder getTensorboardRunOrBuilder()

Required. The TensorboardRun to create.

.google.cloud.aiplatform.v1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TensorboardRunOrBuilder

hasTensorboardRun()

public boolean hasTensorboardRun()

Required. The TensorboardRun to create.

.google.cloud.aiplatform.v1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the tensorboardRun field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateTensorboardRunRequest.Builder newBuilderForType()
Returns
Type Description
CreateTensorboardRunRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateTensorboardRunRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateTensorboardRunRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateTensorboardRunRequest.Builder toBuilder()
Returns
Type Description
CreateTensorboardRunRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException