Google Cloud Ai Platform V1 Client - Class PartialArg (1.47.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PartialArg.

Partial argument value of the function call.

Generated from protobuf message google.cloud.aiplatform.v1.PartialArg

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ null_value int

Optional. Represents a null value.

↳ number_value float

Optional. Represents a double value.

↳ string_value string

Optional. Represents a string value.

↳ bool_value bool

Optional. Represents a boolean value.

↳ json_path string

Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".

↳ will_continue bool

Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.

getNullValue

Optional. Represents a null value.

Returns
Type Description
int Enum of type NullValue.

hasNullValue

setNullValue

Optional. Represents a null value.

Parameter
Name Description
var int

Enum of type NullValue.

Returns
Type Description
$this

getNumberValue

Optional. Represents a double value.

Returns
Type Description
float

hasNumberValue

setNumberValue

Optional. Represents a double value.

Parameter
Name Description
var float
Returns
Type Description
$this

getStringValue

Optional. Represents a string value.

Returns
Type Description
string

hasStringValue

setStringValue

Optional. Represents a string value.

Parameter
Name Description
var string
Returns
Type Description
$this

getBoolValue

Optional. Represents a boolean value.

Returns
Type Description
bool

hasBoolValue

setBoolValue

Optional. Represents a boolean value.

Parameter
Name Description
var bool
Returns
Type Description
$this

getJsonPath

Required. A JSON Path (RFC 9535) to the argument being streamed.

https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".

Returns
Type Description
string

setJsonPath

Required. A JSON Path (RFC 9535) to the argument being streamed.

https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".

Parameter
Name Description
var string
Returns
Type Description
$this

getWillContinue

Optional. Whether this is not the last part of the same json_path.

If true, another PartialArg message for the current json_path is expected to follow.

Returns
Type Description
bool

setWillContinue

Optional. Whether this is not the last part of the same json_path.

If true, another PartialArg message for the current json_path is expected to follow.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDelta

Returns
Type Description
string