Class LookupStudyRequest (3.55.0)

public final class LookupStudyRequest extends GeneratedMessageV3 implements LookupStudyRequestOrBuilder

Request message for VizierService.LookupStudy.

Protobuf type google.cloud.aiplatform.v1.LookupStudyRequest

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LookupStudyRequest getDefaultInstance()
Returns
Type Description
LookupStudyRequest

getDescriptor()

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

newBuilder()

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

newBuilder(LookupStudyRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public LookupStudyRequest getDefaultInstanceForType()
Returns
Type Description
LookupStudyRequest

getDisplayName()

public String getDisplayName()

Required. The user-defined display name of the Study

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The user-defined display name of the Study

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getParent()

public String getParent()

Required. The resource name of the Location to get the Study from. Format: projects/{project}/locations/{location}

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 Location to get the Study from. Format: projects/{project}/locations/{location}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 LookupStudyRequest.Builder newBuilderForType()
Returns
Type Description
LookupStudyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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