Compute V1 Client - Class TargetHttpsProxiesClient (1.8.3)

$targetHttpsProxiesClient = new TargetHttpsProxiesClient();
try {
    $project = 'project';
    // Iterate over pages of elements
    $pagedResponse = $targetHttpsProxiesClient->aggregatedList($project);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $key => $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $targetHttpsProxiesClient->aggregatedList($project);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $targetHttpsProxiesClient->close();
}

Methods

getOperationsClient

resumeOperation

__construct

aggregatedList

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;

/**
 * @param string $project Name of the project scoping this request.
 */
function aggregated_list_sample(string $project): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

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

        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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';

    aggregated_list_sample($project);
}

delete

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource to delete.
 */
function delete_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->delete($project, $targetHttpsProxy);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    delete_sample($project, $targetHttpsProxy);
}

get

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxy;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource to return.
 */
function get_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

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

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    get_sample($project, $targetHttpsProxy);
}

insert

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxy;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 */
function insert_sample(string $project): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetHttpsProxyResource = new TargetHttpsProxy();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->insert($project, $targetHttpsProxyResource);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';

    insert_sample($project);
}

list

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;

/**
 * @param string $project Project ID for this request.
 */
function list_sample(string $project): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

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

        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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';

    list_sample($project);
}

patch

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxy;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource to patch.
 */
function patch_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetHttpsProxyResource = new TargetHttpsProxy();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->patch(
            $project,
            $targetHttpsProxy,
            $targetHttpsProxyResource
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    patch_sample($project, $targetHttpsProxy);
}

setCertificateMap

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxiesSetCertificateMapRequest;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
 */
function set_certificate_map_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetHttpsProxiesSetCertificateMapRequestResource = new TargetHttpsProxiesSetCertificateMapRequest();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->setCertificateMap(
            $project,
            $targetHttpsProxiesSetCertificateMapRequestResource,
            $targetHttpsProxy
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    set_certificate_map_sample($project, $targetHttpsProxy);
}

setQuicOverride

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxiesSetQuicOverrideRequest;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.
 */
function set_quic_override_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetHttpsProxiesSetQuicOverrideRequestResource = new TargetHttpsProxiesSetQuicOverrideRequest();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->setQuicOverride(
            $project,
            $targetHttpsProxiesSetQuicOverrideRequestResource,
            $targetHttpsProxy
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    set_quic_override_sample($project, $targetHttpsProxy);
}

setSslCertificates

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\TargetHttpsProxiesSetSslCertificatesRequest;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
 */
function set_ssl_certificates_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $targetHttpsProxiesSetSslCertificatesRequestResource = new TargetHttpsProxiesSetSslCertificatesRequest();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->setSslCertificates(
            $project,
            $targetHttpsProxiesSetSslCertificatesRequestResource,
            $targetHttpsProxy
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    set_ssl_certificates_sample($project, $targetHttpsProxy);
}

setSslPolicy

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\SslPolicyReference;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
 */
function set_ssl_policy_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $sslPolicyReferenceResource = new SslPolicyReference();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->setSslPolicy(
            $project,
            $sslPolicyReferenceResource,
            $targetHttpsProxy
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    set_ssl_policy_sample($project, $targetHttpsProxy);
}

setUrlMap

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\TargetHttpsProxiesClient;
use Google\Cloud\Compute\V1\UrlMapReference;
use Google\Rpc\Status;

/**
 * @param string $project          Project ID for this request.
 * @param string $targetHttpsProxy Name of the TargetHttpsProxy resource whose URL map is to be set.
 */
function set_url_map_sample(string $project, string $targetHttpsProxy): void
{
    // Create a client.
    $targetHttpsProxiesClient = new TargetHttpsProxiesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $urlMapReferenceResource = new UrlMapReference();

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $targetHttpsProxiesClient->setUrlMap(
            $project,
            $targetHttpsProxy,
            $urlMapReferenceResource
        );
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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());
    }
}

/**
 * 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
{
    $project = '[PROJECT]';
    $targetHttpsProxy = '[TARGET_HTTPS_PROXY]';

    set_url_map_sample($project, $targetHttpsProxy);
}

Constants

SERVICE_NAME

Value: 'google.cloud.compute.v1.TargetHttpsProxies'

SERVICE_ADDRESS

Value: 'compute.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'