Google Cloud Managed Kafka V1 Client - Class ManagedKafkaClient (0.1.0)

Namespace

Methods

__construct

createCluster

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedKafka\V1\AccessConfig;
use Google\Cloud\ManagedKafka\V1\CapacityConfig;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\Cluster;
use Google\Cloud\ManagedKafka\V1\CreateClusterRequest;
use Google\Cloud\ManagedKafka\V1\GcpConfig;
use Google\Cloud\ManagedKafka\V1\NetworkConfig;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                  The parent region in which to create the cluster. Structured like
 *                                                                 `projects/{project}/locations/{location}`. Please see
 *                                                                 {@see ManagedKafkaClient::locationName()} for help formatting this field.
 * @param string $clusterId                                        The ID to use for the cluster, which will become the final
 *                                                                 component of the cluster's name. The ID must be 1-63 characters long, and
 *                                                                 match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with
 *                                                                 RFC 1035.
 *
 *                                                                 This value is structured like: `my-cluster-id`.
 * @param string $clusterGcpConfigAccessConfigNetworkConfigsSubnet Name of the VPC subnet in which to create Private Service Connect
 *                                                                 (PSC) endpoints for the Kafka brokers and bootstrap address. Structured
 *                                                                 like: projects/{project}/regions/{region}/subnetworks/{subnet_id}
 *
 *                                                                 The subnet must be located in the same region as the Kafka cluster. The
 *                                                                 project may differ. Multiple subnets from the same parent network must not
 *                                                                 be specified.
 *
 *                                                                 The CIDR range of the subnet must be within the IPv4 address ranges for
 *                                                                 private networks, as specified in RFC 1918.
 * @param int    $clusterCapacityConfigVcpuCount                   The number of vCPUs to provision for the cluster. Minimum: 3.
 * @param int    $clusterCapacityConfigMemoryBytes                 The memory to provision for the cluster in bytes.
 *                                                                 The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8.
 *                                                                 Minimum: 3221225472 (3 GiB).
 */
function create_cluster_sample(
    string $formattedParent,
    string $clusterId,
    string $clusterGcpConfigAccessConfigNetworkConfigsSubnet,
    int $clusterCapacityConfigVcpuCount,
    int $clusterCapacityConfigMemoryBytes
): void {
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $networkConfig = (new NetworkConfig())
        ->setSubnet($clusterGcpConfigAccessConfigNetworkConfigsSubnet);
    $clusterGcpConfigAccessConfigNetworkConfigs = [$networkConfig,];
    $clusterGcpConfigAccessConfig = (new AccessConfig())
        ->setNetworkConfigs($clusterGcpConfigAccessConfigNetworkConfigs);
    $clusterGcpConfig = (new GcpConfig())
        ->setAccessConfig($clusterGcpConfigAccessConfig);
    $clusterCapacityConfig = (new CapacityConfig())
        ->setVcpuCount($clusterCapacityConfigVcpuCount)
        ->setMemoryBytes($clusterCapacityConfigMemoryBytes);
    $cluster = (new Cluster())
        ->setGcpConfig($clusterGcpConfig)
        ->setCapacityConfig($clusterCapacityConfig);
    $request = (new CreateClusterRequest())
        ->setParent($formattedParent)
        ->setClusterId($clusterId)
        ->setCluster($cluster);

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

        if ($response->operationSucceeded()) {
            /** @var Cluster $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 = ManagedKafkaClient::locationName('[PROJECT]', '[LOCATION]');
    $clusterId = '[CLUSTER_ID]';
    $clusterGcpConfigAccessConfigNetworkConfigsSubnet = '[SUBNET]';
    $clusterCapacityConfigVcpuCount = 0;
    $clusterCapacityConfigMemoryBytes = 0;

    create_cluster_sample(
        $formattedParent,
        $clusterId,
        $clusterGcpConfigAccessConfigNetworkConfigsSubnet,
        $clusterCapacityConfigVcpuCount,
        $clusterCapacityConfigMemoryBytes
    );
}

createTopic

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\CreateTopicRequest;
use Google\Cloud\ManagedKafka\V1\Topic;

/**
 * @param string $formattedParent        The parent cluster in which to create the topic.
 *                                       Structured like
 *                                       `projects/{project}/locations/{location}/clusters/{cluster}`. Please see
 *                                       {@see ManagedKafkaClient::clusterName()} for help formatting this field.
 * @param string $topicId                The ID to use for the topic, which will become the final
 *                                       component of the topic's name.
 *
 *                                       This value is structured like: `my-topic-name`.
 * @param int    $topicPartitionCount    The number of partitions this topic has. The partition count can
 *                                       only be increased, not decreased. Please note that if partitions are
 *                                       increased for a topic that has a key, the partitioning logic or the
 *                                       ordering of the messages will be affected.
 * @param int    $topicReplicationFactor Immutable. The number of replicas of each partition. A
 *                                       replication factor of 3 is recommended for high availability.
 */
function create_topic_sample(
    string $formattedParent,
    string $topicId,
    int $topicPartitionCount,
    int $topicReplicationFactor
): void {
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $topic = (new Topic())
        ->setPartitionCount($topicPartitionCount)
        ->setReplicationFactor($topicReplicationFactor);
    $request = (new CreateTopicRequest())
        ->setParent($formattedParent)
        ->setTopicId($topicId)
        ->setTopic($topic);

    // Call the API and handle any network failures.
    try {
        /** @var Topic $response */
        $response = $managedKafkaClient->createTopic($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
{
    $formattedParent = ManagedKafkaClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');
    $topicId = '[TOPIC_ID]';
    $topicPartitionCount = 0;
    $topicReplicationFactor = 0;

    create_topic_sample($formattedParent, $topicId, $topicPartitionCount, $topicReplicationFactor);
}

deleteCluster

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\DeleteClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the cluster to delete. Please see
 *                              {@see ManagedKafkaClient::clusterName()} for help formatting this field.
 */
function delete_cluster_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new DeleteClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $managedKafkaClient->deleteCluster($request);
        $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());
    }
}

/**
 * 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
{
    $formattedName = ManagedKafkaClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    delete_cluster_sample($formattedName);
}

deleteConsumerGroup

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\DeleteConsumerGroupRequest;

/**
 * @param string $formattedName The name of the consumer group to delete.
 *                              `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. Please see
 *                              {@see ManagedKafkaClient::consumerGroupName()} for help formatting this field.
 */
function delete_consumer_group_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new DeleteConsumerGroupRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $managedKafkaClient->deleteConsumerGroup($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $formattedName = ManagedKafkaClient::consumerGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLUSTER]',
        '[CONSUMER_GROUP]'
    );

    delete_consumer_group_sample($formattedName);
}

deleteTopic

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\DeleteTopicRequest;

/**
 * @param string $formattedName The name of the topic to delete.
 *                              `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`. Please see
 *                              {@see ManagedKafkaClient::topicName()} for help formatting this field.
 */
function delete_topic_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new DeleteTopicRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $managedKafkaClient->deleteTopic($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $formattedName = ManagedKafkaClient::topicName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[TOPIC]');

    delete_topic_sample($formattedName);
}

getCluster

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\Cluster;
use Google\Cloud\ManagedKafka\V1\GetClusterRequest;

/**
 * @param string $formattedName The name of the cluster whose configuration to return. Please see
 *                              {@see ManagedKafkaClient::clusterName()} for help formatting this field.
 */
function get_cluster_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new GetClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Cluster $response */
        $response = $managedKafkaClient->getCluster($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
{
    $formattedName = ManagedKafkaClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    get_cluster_sample($formattedName);
}

getConsumerGroup

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\ConsumerGroup;
use Google\Cloud\ManagedKafka\V1\GetConsumerGroupRequest;

/**
 * @param string $formattedName The name of the consumer group whose configuration to return.
 *                              `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. Please see
 *                              {@see ManagedKafkaClient::consumerGroupName()} for help formatting this field.
 */
function get_consumer_group_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new GetConsumerGroupRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ConsumerGroup $response */
        $response = $managedKafkaClient->getConsumerGroup($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
{
    $formattedName = ManagedKafkaClient::consumerGroupName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLUSTER]',
        '[CONSUMER_GROUP]'
    );

    get_consumer_group_sample($formattedName);
}

getTopic

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\GetTopicRequest;
use Google\Cloud\ManagedKafka\V1\Topic;

/**
 * @param string $formattedName The name of the topic whose configuration to return. Structured
 *                              like:
 *                              projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}. Please see
 *                              {@see ManagedKafkaClient::topicName()} for help formatting this field.
 */
function get_topic_sample(string $formattedName): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = (new GetTopicRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Topic $response */
        $response = $managedKafkaClient->getTopic($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
{
    $formattedName = ManagedKafkaClient::topicName('[PROJECT]', '[LOCATION]', '[CLUSTER]', '[TOPIC]');

    get_topic_sample($formattedName);
}

listClusters

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\Cluster;
use Google\Cloud\ManagedKafka\V1\ListClustersRequest;

/**
 * @param string $formattedParent The parent location whose clusters are to be listed. Structured
 *                                like `projects/{project}/locations/{location}`. Please see
 *                                {@see ManagedKafkaClient::locationName()} for help formatting this field.
 */
function list_clusters_sample(string $formattedParent): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

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

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

        /** @var Cluster $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
{
    $formattedParent = ManagedKafkaClient::locationName('[PROJECT]', '[LOCATION]');

    list_clusters_sample($formattedParent);
}

listConsumerGroups

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\ConsumerGroup;
use Google\Cloud\ManagedKafka\V1\ListConsumerGroupsRequest;

/**
 * @param string $formattedParent The parent cluster whose consumer groups are to be listed.
 *                                Structured like
 *                                `projects/{project}/locations/{location}/clusters/{cluster}`. Please see
 *                                {@see ManagedKafkaClient::clusterName()} for help formatting this field.
 */
function list_consumer_groups_sample(string $formattedParent): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

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

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

        /** @var ConsumerGroup $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
{
    $formattedParent = ManagedKafkaClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    list_consumer_groups_sample($formattedParent);
}

listTopics

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\ListTopicsRequest;
use Google\Cloud\ManagedKafka\V1\Topic;

/**
 * @param string $formattedParent The parent cluster whose topics are to be listed. Structured like
 *                                `projects/{project}/locations/{location}/clusters/{cluster}`. Please see
 *                                {@see ManagedKafkaClient::clusterName()} for help formatting this field.
 */
function list_topics_sample(string $formattedParent): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

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

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

        /** @var Topic $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
{
    $formattedParent = ManagedKafkaClient::clusterName('[PROJECT]', '[LOCATION]', '[CLUSTER]');

    list_topics_sample($formattedParent);
}

updateCluster

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ManagedKafka\V1\AccessConfig;
use Google\Cloud\ManagedKafka\V1\CapacityConfig;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\Cluster;
use Google\Cloud\ManagedKafka\V1\GcpConfig;
use Google\Cloud\ManagedKafka\V1\NetworkConfig;
use Google\Cloud\ManagedKafka\V1\UpdateClusterRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $clusterGcpConfigAccessConfigNetworkConfigsSubnet Name of the VPC subnet in which to create Private Service Connect
 *                                                                 (PSC) endpoints for the Kafka brokers and bootstrap address. Structured
 *                                                                 like: projects/{project}/regions/{region}/subnetworks/{subnet_id}
 *
 *                                                                 The subnet must be located in the same region as the Kafka cluster. The
 *                                                                 project may differ. Multiple subnets from the same parent network must not
 *                                                                 be specified.
 *
 *                                                                 The CIDR range of the subnet must be within the IPv4 address ranges for
 *                                                                 private networks, as specified in RFC 1918.
 * @param int    $clusterCapacityConfigVcpuCount                   The number of vCPUs to provision for the cluster. Minimum: 3.
 * @param int    $clusterCapacityConfigMemoryBytes                 The memory to provision for the cluster in bytes.
 *                                                                 The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8.
 *                                                                 Minimum: 3221225472 (3 GiB).
 */
function update_cluster_sample(
    string $clusterGcpConfigAccessConfigNetworkConfigsSubnet,
    int $clusterCapacityConfigVcpuCount,
    int $clusterCapacityConfigMemoryBytes
): void {
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $networkConfig = (new NetworkConfig())
        ->setSubnet($clusterGcpConfigAccessConfigNetworkConfigsSubnet);
    $clusterGcpConfigAccessConfigNetworkConfigs = [$networkConfig,];
    $clusterGcpConfigAccessConfig = (new AccessConfig())
        ->setNetworkConfigs($clusterGcpConfigAccessConfigNetworkConfigs);
    $clusterGcpConfig = (new GcpConfig())
        ->setAccessConfig($clusterGcpConfigAccessConfig);
    $clusterCapacityConfig = (new CapacityConfig())
        ->setVcpuCount($clusterCapacityConfigVcpuCount)
        ->setMemoryBytes($clusterCapacityConfigMemoryBytes);
    $cluster = (new Cluster())
        ->setGcpConfig($clusterGcpConfig)
        ->setCapacityConfig($clusterCapacityConfig);
    $request = (new UpdateClusterRequest())
        ->setUpdateMask($updateMask)
        ->setCluster($cluster);

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

        if ($response->operationSucceeded()) {
            /** @var Cluster $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
{
    $clusterGcpConfigAccessConfigNetworkConfigsSubnet = '[SUBNET]';
    $clusterCapacityConfigVcpuCount = 0;
    $clusterCapacityConfigMemoryBytes = 0;

    update_cluster_sample(
        $clusterGcpConfigAccessConfigNetworkConfigsSubnet,
        $clusterCapacityConfigVcpuCount,
        $clusterCapacityConfigMemoryBytes
    );
}

updateConsumerGroup

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\ConsumerGroup;
use Google\Cloud\ManagedKafka\V1\UpdateConsumerGroupRequest;
use Google\Protobuf\FieldMask;

/**
 * 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 update_consumer_group_sample(): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $consumerGroup = new ConsumerGroup();
    $request = (new UpdateConsumerGroupRequest())
        ->setUpdateMask($updateMask)
        ->setConsumerGroup($consumerGroup);

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

updateTopic

use Google\ApiCore\ApiException;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;
use Google\Cloud\ManagedKafka\V1\Topic;
use Google\Cloud\ManagedKafka\V1\UpdateTopicRequest;
use Google\Protobuf\FieldMask;

/**
 * @param int $topicPartitionCount    The number of partitions this topic has. The partition count can
 *                                    only be increased, not decreased. Please note that if partitions are
 *                                    increased for a topic that has a key, the partitioning logic or the
 *                                    ordering of the messages will be affected.
 * @param int $topicReplicationFactor Immutable. The number of replicas of each partition. A
 *                                    replication factor of 3 is recommended for high availability.
 */
function update_topic_sample(int $topicPartitionCount, int $topicReplicationFactor): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $topic = (new Topic())
        ->setPartitionCount($topicPartitionCount)
        ->setReplicationFactor($topicReplicationFactor);
    $request = (new UpdateTopicRequest())
        ->setUpdateMask($updateMask)
        ->setTopic($topic);

    // Call the API and handle any network failures.
    try {
        /** @var Topic $response */
        $response = $managedKafkaClient->updateTopic($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
{
    $topicPartitionCount = 0;
    $topicReplicationFactor = 0;

    update_topic_sample($topicPartitionCount, $topicReplicationFactor);
}

getLocation

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

listLocations

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ManagedKafka\V1\Client\ManagedKafkaClient;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $managedKafkaClient = new ManagedKafkaClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $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());
    }
}

createClusterAsync

createTopicAsync

deleteClusterAsync

deleteConsumerGroupAsync

deleteTopicAsync

getClusterAsync

getConsumerGroupAsync

getTopicAsync

listClustersAsync

listConsumerGroupsAsync

listTopicsAsync

updateClusterAsync

updateConsumerGroupAsync

updateTopicAsync

getLocationAsync

listLocationsAsync

getOperationsClient

resumeOperation

static::clusterName

static::consumerGroupName

static::cryptoKeyName

static::locationName

static::topicName

static::parseName