# Google Cloud Ai Platform V1 Client - Class FunctionCall (1.60.0)

1.60.0 (latest) 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0 Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FunctionCall.

A predicted \[FunctionCall\] returned from the model that contains a string
representing the \[FunctionDeclaration.name\] and a structured JSON object
containing the parameters and their values.

Generated from protobuf message `google.cloud.aiplatform.v1.FunctionCall`

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Optional. The name of the function to call. Matches \[FunctionDeclaration.name\]. |
| `↳ args` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` Optional. The function parameters and values in JSON object format. See \[FunctionDeclaration.parameters\] for parameter details. |
| `↳ partial_args` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PartialArg>` Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. |
| `↳ will_continue` | `bool` Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. |

### getName

Optional. The name of the function to call.

Matches \[FunctionDeclaration.name\].

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Optional. The name of the function to call.

Matches \[FunctionDeclaration.name\].

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getArgs

Optional. The function parameters and values in JSON object format.

See \[FunctionDeclaration.parameters\] for parameter details.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct|null` |   |

### hasArgs

### clearArgs

### setArgs

Optional. The function parameters and values in JSON object format.

See \[FunctionDeclaration.parameters\] for parameter details.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPartialArgs

Optional. The partial argument value of the function call.

If provided, represents the arguments/fields that are streamed
incrementally.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PartialArg>` |   |

### setPartialArgs

Optional. The partial argument value of the function call.

If provided, represents the arguments/fields that are streamed
incrementally.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.PartialArg>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getWillContinue

Optional. Whether this is the last part of the FunctionCall.

If true, another partial message for the current FunctionCall is expected
to follow.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setWillContinue

Optional. Whether this is the last part of the FunctionCall.

If true, another partial message for the current FunctionCall is expected
to follow.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |