Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions pubsub/api/src/update_topic_type.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?php

/**
* Copyright 2025 Google LLC.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/blob/main/pubsub/api/README.md
*/

namespace Google\Cloud\Samples\PubSub;

# [START pubsub_update_topic_type]
use Google\Cloud\PubSub\PubSubClient;

/**
* Changes the type of a Pub/Sub topic.
*
* @param string $projectId The Google project ID.
* @param string $topicName The Pub/Sub topic name.
* @param string $streamArn The Kinesis stream ARN to ingest data from.
* @param string $consumerArn The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.
* @param string $awsRoleArn AWS role ARN to be used for Federated Identity authentication with Kinesis. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.
* @param string $gcpServiceAccount The GCP service account to be used for Federated Identity authentication with Kinesis (via a AssumeRoleWithWebIdentity call for the provided role). The $awsRoleArn must be set up with accounts.google.com:sub equals to this service account number.
*/
function update_topic_type(
string $projectId,
string $topicName,
string $streamArn,
string $consumerArn,
string $awsRoleArn,
string $gcpServiceAccount
): void {
$pubsub = new PubSubClient([
'projectId' => $projectId,
]);

$topic = $pubsub->topic($topicName, [
'ingestionDataSourceSettings' => [
'aws_kinesis' => [
'stream_arn' => $streamArn,
'consumer_arn' => $consumerArn,
'aws_role_arn' => $awsRoleArn,
'gcp_service_account' => $gcpServiceAccount
]
]
]);

$topic->update([], [
'updateMask' => [ 'ingestionDataSourceSettings' ]
]);
Copy link
Contributor

@bshaffer bshaffer Jun 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a valid way to do it, but I think when updating, the API would normally look a bit more like this:

Suggested change
$topic = $pubsub->topic($topicName, [
'ingestionDataSourceSettings' => [
'aws_kinesis' => [
'stream_arn' => $streamArn,
'consumer_arn' => $consumerArn,
'aws_role_arn' => $awsRoleArn,
'gcp_service_account' => $gcpServiceAccount
]
]
]);
$topic->update([], [
'updateMask' => [ 'ingestionDataSourceSettings' ]
]);
$topic = $pubsub->topic($topicName);
$topic->update([
'ingestionDataSourceSettings' => [
'aws_kinesis' => [
'stream_arn' => $streamArn,
'consumer_arn' => $consumerArn,
'aws_role_arn' => $awsRoleArn,
'gcp_service_account' => $gcpServiceAccount
]
]
], [
'updateMask' => [
'ingestionDataSourceSettings'
]
]);


printf('Topic updated: %s' . PHP_EOL, $topic->name());
}
# [END pubsub_update_topic_type]
require_once __DIR__ . '/../../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
24 changes: 24 additions & 0 deletions pubsub/api/test/pubsubTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -600,4 +600,28 @@ public function testOptimisticSubscribe()
$this->assertMatchesRegularExpression('/Subscription deleted:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $subcriptionId), $output);
}

public function testUpdateTopicType()
{
$topic = 'test-topic-' . rand();
$output = $this->runFunctionSnippet('create_topic', [
self::$projectId,
$topic,
]);

$this->assertMatchesRegularExpression('/Topic created:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);

$output = $this->runFunctionSnippet('update_topic_type', [
self::$projectId,
$topic,
'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name',
'arn:aws:kinesis:us-west-2:111111111111:stream/fake-stream-name/consumer/consumer-1:1111111111',
self::$awsRoleArn,
self::$gcpServiceAccount
]);

$this->assertMatchesRegularExpression('/Topic updated:/', $output);
$this->assertMatchesRegularExpression(sprintf('/%s/', $topic), $output);
}
}