# Google Cloud Commerce Consumer Procurement V1 Client - Class ConsumerProcurementServiceClient (1.3.3)

1.3.3 (latest) 1.3.2 1.2.2 1.1.3 1.0.0 0.2.5 0.1.1 Reference documentation and code samples for the Google Cloud Commerce Consumer Procurement V1 Client class ConsumerProcurementServiceClient.

Service Description: ConsumerProcurementService allows customers to make purchases of products
served by the Cloud Commerce platform.

When purchases are made, the
[ConsumerProcurementService](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient)
programs the appropriate backends, including both Google's own
infrastructure, as well as third-party systems, and to enable billing setup
for charging for the procured item.

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To
assist with these names, this class includes a format method for each type of
name, and additionally a parseName method to extract the individual identifiers
contained within formatted names that are returned by the API.

## Namespace

Google \\ Cloud \\ Commerce \\ Consumer \\ Procurement \\ V1 \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` Optional. Options for configuring the service API wrapper. |
| `↳ apiEndpoint` | `string` The address of the API remote host. May optionally include the port, formatted as " |
| `↳ credentials` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Commerce\Consumer\Procurement\V1\ConsumerProcurementServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new ConsumerProcurementServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ credentialsConfig` | `array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see [Google\\ApiCore\\CredentialsWrapper::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_Google_ApiCore_CredentialsWrapper__build__) . |
| `↳ disableRetries` | `bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`. |
| `↳ clientConfig` | `string|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
| `↳ transport` | `string|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage* : Additionally, it is possible to pass in an already instantiated [Google\\ApiCore\\Transport\\TransportInterface](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored. |
| `↳ transportConfig` | `array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = \[ 'grpc' =\> \[...\], 'rest' =\> \[...\], \]; See the [Google\\ApiCore\\Transport\\GrpcTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_Google_ApiCore_Transport_RestTransport__build__) methods for the supported options. |
| `↳ clientCertSource` | `callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### cancelOrder

Cancels an existing
[Order](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order). Every product
procured in the Order will be cancelled.

The async variant is [ConsumerProcurementServiceClient::cancelOrderAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient#_Google_Cloud_Commerce_Consumer_Procurement_V1_Client_ConsumerProcurementServiceClient__cancelOrderAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.CancelOrderRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderRequest;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;
    use Google\Rpc\Status;

    /**
     * @param string $name The resource name of the order.
     */
    function cancel_order_sample(string $name): void
    {
        // Create a client.
        $consumerProcurementServiceClient = new ConsumerProcurementServiceClient();

        // Prepare the request message.
        $request = (new CancelOrderRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $consumerProcurementServiceClient->cancelOrder($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                /** @var Order $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $name = '[NAME]';

        cancel_order_sample($name);
    }

### getOrder

Returns the requested
[Order](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order) resource.

The async variant is [ConsumerProcurementServiceClient::getOrderAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient#_Google_Cloud_Commerce_Consumer_Procurement_V1_Client_ConsumerProcurementServiceClient__getOrderAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.GetOrderRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\GetOrderRequest;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;

    /**
     * @param string $name The name of the order to retrieve.
     */
    function get_order_sample(string $name): void
    {
        // Create a client.
        $consumerProcurementServiceClient = new ConsumerProcurementServiceClient();

        // Prepare the request message.
        $request = (new GetOrderRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            /** @var Order $response */
            $response = $consumerProcurementServiceClient->getOrder($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $name = '[NAME]';

        get_order_sample($name);
    }

### listOrders

Lists [Order](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order)
resources that the user has access to, within the scope of the parent
resource.

The async variant is [ConsumerProcurementServiceClient::listOrdersAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient#_Google_Cloud_Commerce_Consumer_Procurement_V1_Client_ConsumerProcurementServiceClient__listOrdersAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.ListOrdersRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\PagedListResponse;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersRequest;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;

    /**
     * @param string $parent The parent resource to query for orders.
     *                       This field has the form `billingAccounts/{billing-account-id}`.
     */
    function list_orders_sample(string $parent): void
    {
        // Create a client.
        $consumerProcurementServiceClient = new ConsumerProcurementServiceClient();

        // Prepare the request message.
        $request = (new ListOrdersRequest())
            ->setParent($parent);

        // Call the API and handle any network failures.
        try {
            /** @var PagedListResponse $response */
            $response = $consumerProcurementServiceClient->listOrders($request);

            /** @var Order $element */
            foreach ($response as $element) {
                printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $parent = '[PARENT]';

        list_orders_sample($parent);
    }

### modifyOrder

Modifies an existing
[Order](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order) resource.

The async variant is [ConsumerProcurementServiceClient::modifyOrderAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient#_Google_Cloud_Commerce_Consumer_Procurement_V1_Client_ConsumerProcurementServiceClient__modifyOrderAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.ModifyOrderRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;
    use Google\Rpc\Status;

    /**
     * @param string $name Name of the order to update.
     */
    function modify_order_sample(string $name): void
    {
        // Create a client.
        $consumerProcurementServiceClient = new ConsumerProcurementServiceClient();

        // Prepare the request message.
        $request = (new ModifyOrderRequest())
            ->setName($name);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $consumerProcurementServiceClient->modifyOrder($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                /** @var Order $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $name = '[NAME]';

        modify_order_sample($name);
    }

### placeOrder

Creates a new [Order](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order).

This API only supports GCP spend-based committed use
discounts specified by GCP documentation.

The returned long-running operation is in-progress until the backend
completes the creation of the resource. Once completed, the order is
in
OrderState.ORDER_STATE_ACTIVE.
In case of failure, the order resource will be removed.

The async variant is [ConsumerProcurementServiceClient::placeOrderAsync()](https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Client.ConsumerProcurementServiceClient#_Google_Cloud_Commerce_Consumer_Procurement_V1_Client_ConsumerProcurementServiceClient__placeOrderAsync__)
.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.PlaceOrderRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html<https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order>` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\ApiCore\OperationResponse;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Client\ConsumerProcurementServiceClient;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;
    use Google\Cloud\Commerce\Consumer\Procurement\V1\PlaceOrderRequest;
    use Google\Rpc\Status;

    /**
     * @param string $formattedParent The resource name of the parent resource.
     *                                This field has the form  `billingAccounts/{billing-account-id}`. Please see
     *                                {@see ConsumerProcurementServiceClient::billingAccountName()} for help formatting this field.
     * @param string $displayName     The user-specified name of the order being placed.
     */
    function place_order_sample(string $formattedParent, string $displayName): void
    {
        // Create a client.
        $consumerProcurementServiceClient = new ConsumerProcurementServiceClient();

        // Prepare the request message.
        $request = (new PlaceOrderRequest())
            ->setParent($formattedParent)
            ->setDisplayName($displayName);

        // Call the API and handle any network failures.
        try {
            /** @var OperationResponse $response */
            $response = $consumerProcurementServiceClient->placeOrder($request);
            $response->pollUntilComplete();

            if ($response->operationSucceeded()) {
                /** @var Order $result */
                $result = $response->getResult();
                printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
            } else {
                /** @var Status $error */
                $error = $response->getError();
                printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
            }
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample has been automatically generated and should be regarded as a code
     * template only. It will require modifications to work:
     *  - It may require correct/in-range values for request initialization.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedParent = ConsumerProcurementServiceClient::billingAccountName('[BILLING_ACCOUNT]');
        $displayName = '[DISPLAY_NAME]';

        place_order_sample($formattedParent, $displayName);
    }

### cancelOrderAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.CancelOrderRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getOrderAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.GetOrderRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.Order>` |   |

### listOrdersAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.ListOrdersRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/PagedListResponse.html>` |   |

### modifyOrderAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.ModifyOrderRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### placeOrderAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/cloud-commerce-consumer-procurement/latest/V1.PlaceOrderRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html>` |   |

### getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\LongRunning\Client\OperationsClient` |   |

### resumeOperation

Resume an existing long running operation that was previously started by a long
running API method. If $methodName is not provided, or does not match a long
running API method, then the operation can still be resumed, but the
OperationResponse object will not deserialize the final response.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `operationName` | `string` The name of the long running operation |
| `methodName` | `string` The name of the method used to start the operation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/gax/latest/OperationResponse.html` |   |

### static::billingAccountName

Formats a string containing the fully-qualified path to represent a
billing_account resource.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted billing_account resource. |

### static::consumerBillingAccountOfferName

Formats a string containing the fully-qualified path to represent a
consumer_billing_account_offer resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `consumerBillingAccount` | `string` |
| `offer` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted consumer_billing_account_offer resource. |

### static::offerName

Formats a string containing the fully-qualified path to represent a offer
resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `service` | `string` |
| `offer` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted offer resource. |

### static::serviceOfferName

Formats a string containing the fully-qualified path to represent a
service_offer resource.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `service` | `string` |
| `offer` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted service_offer resource. |

### static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported:
Template: Pattern

- billingAccount: billingAccounts/{billing_account}
- consumerBillingAccountOffer: billingAccounts/{consumer_billing_account}/offers/{offer}
- offer: services/{service}/standardOffers/{offer}
- serviceOffer: services/{service}/standardOffers/{offer}

The optional $template argument can be supplied to specify a particular pattern,
and must match one of the templates listed above. If no $template argument is
provided, or if the $template argument does not match one of the templates
listed, then parseName will check each of the supported templates, and return
the first match.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `formattedName` | `string` The formatted name string |
| `template` | `?string` Optional name of template to match |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `array` | An associative array from name component IDs to component values. |