Class CreateSessionRequest.Builder (3.88.0)

public static final class CreateSessionRequest.Builder extends GeneratedMessage.Builder<CreateSessionRequest.Builder> implements CreateSessionRequestOrBuilder

Request message for SessionService.CreateSession.

Protobuf type google.cloud.aiplatform.v1beta1.CreateSessionRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateSessionRequest build()
Returns
Type Description
CreateSessionRequest

buildPartial()

public CreateSessionRequest buildPartial()
Returns
Type Description
CreateSessionRequest

clear()

public CreateSessionRequest.Builder clear()
Returns
Type Description
CreateSessionRequest.Builder
Overrides

clearParent()

public CreateSessionRequest.Builder clearParent()

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.

clearSession()

public CreateSessionRequest.Builder clearSession()

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateSessionRequest.Builder

clearSessionId()

public CreateSessionRequest.Builder clearSessionId()

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public CreateSessionRequest getDefaultInstanceForType()
Returns
Type Description
CreateSessionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getParent()

public String getParent()

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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 create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Returns
Type Description
ByteString

The bytes for parent.

getSession()

public Session getSession()

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Session

The session.

getSessionBuilder()

public Session.Builder getSessionBuilder()

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Session.Builder

getSessionId()

public String getSessionId()

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sessionId.

getSessionIdBytes()

public ByteString getSessionIdBytes()

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sessionId.

getSessionOrBuilder()

public SessionOrBuilder getSessionOrBuilder()

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SessionOrBuilder

hasSession()

public boolean hasSession()

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the session field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreateSessionRequest other)

public CreateSessionRequest.Builder mergeFrom(CreateSessionRequest other)
Parameter
Name Description
other CreateSessionRequest
Returns
Type Description
CreateSessionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateSessionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateSessionRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateSessionRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateSessionRequest.Builder
Overrides

mergeSession(Session value)

public CreateSessionRequest.Builder mergeSession(Session value)

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Session
Returns
Type Description
CreateSessionRequest.Builder

setParent(String value)

public CreateSessionRequest.Builder setParent(String value)

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateSessionRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.

setSession(Session value)

public CreateSessionRequest.Builder setSession(Session value)

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Session
Returns
Type Description
CreateSessionRequest.Builder

setSession(Session.Builder builderForValue)

public CreateSessionRequest.Builder setSession(Session.Builder builderForValue)

Required. The session to create.

.google.cloud.aiplatform.v1beta1.Session session = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Session.Builder
Returns
Type Description
CreateSessionRequest.Builder

setSessionId(String value)

public CreateSessionRequest.Builder setSessionId(String value)

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The sessionId to set.

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.

setSessionIdBytes(ByteString value)

public CreateSessionRequest.Builder setSessionIdBytes(ByteString value)

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID.

This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first character must be a letter, and the last character must be a letter or number.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for sessionId to set.

Returns
Type Description
CreateSessionRequest.Builder

This builder for chaining.