/*

* Copyright 2026 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

*

* https://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.

*/

package com.google.cloud.pubsub.v1;

import com.google.api.core.ApiFuture;

import com.google.api.core.ApiFutures;

import com.google.api.gax.core.BackgroundResource;

import com.google.api.gax.paging.AbstractFixedSizeCollection;

import com.google.api.gax.paging.AbstractPage;

import com.google.api.gax.paging.AbstractPagedListResponse;

import com.google.api.gax.rpc.BidiStreamingCallable;

import com.google.api.gax.rpc.PageContext;

import com.google.api.gax.rpc.UnaryCallable;

import com.google.cloud.pubsub.v1.stub.SubscriberStub;

import com.google.cloud.pubsub.v1.stub.SubscriberStubSettings;

import com.google.common.util.concurrent.MoreExecutors;

import com.google.iam.v1.GetIamPolicyRequest;

import com.google.iam.v1.Policy;

import com.google.iam.v1.SetIamPolicyRequest;

import com.google.iam.v1.TestIamPermissionsRequest;

import com.google.iam.v1.TestIamPermissionsResponse;

import com.google.protobuf.Empty;

import com.google.protobuf.FieldMask;

import com.google.pubsub.v1.AcknowledgeRequest;

import com.google.pubsub.v1.CreateSnapshotRequest;

import com.google.pubsub.v1.DeleteSnapshotRequest;

import com.google.pubsub.v1.DeleteSubscriptionRequest;

import com.google.pubsub.v1.GetSnapshotRequest;

import com.google.pubsub.v1.GetSubscriptionRequest;

import com.google.pubsub.v1.ListSnapshotsRequest;

import com.google.pubsub.v1.ListSnapshotsResponse;

import com.google.pubsub.v1.ListSubscriptionsRequest;

import com.google.pubsub.v1.ListSubscriptionsResponse;

import com.google.pubsub.v1.ModifyAckDeadlineRequest;

import com.google.pubsub.v1.ModifyPushConfigRequest;

import com.google.pubsub.v1.ProjectName;

import com.google.pubsub.v1.ProjectSnapshotName;

import com.google.pubsub.v1.ProjectSubscriptionName;

import com.google.pubsub.v1.ProjectTopicName;

import com.google.pubsub.v1.PullRequest;

import com.google.pubsub.v1.PullResponse;

import com.google.pubsub.v1.PushConfig;

import com.google.pubsub.v1.SeekRequest;

import com.google.pubsub.v1.SeekResponse;

import com.google.pubsub.v1.Snapshot;

import com.google.pubsub.v1.SnapshotName;

import com.google.pubsub.v1.StreamingPullRequest;

import com.google.pubsub.v1.StreamingPullResponse;

import com.google.pubsub.v1.Subscription;

import com.google.pubsub.v1.SubscriptionName;

import com.google.pubsub.v1.TopicName;

import com.google.pubsub.v1.UpdateSnapshotRequest;

import com.google.pubsub.v1.UpdateSubscriptionRequest;

import java.io.IOException;

import java.util.List;

import java.util.concurrent.TimeUnit;

import javax.annotation.Generated;

import org.jspecify.annotations.NullMarked;

import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.

/**

* Service Description: The service that an application uses to manipulate subscriptions and to

* consume messages from a subscription via the `Pull` method or by establishing a bi-directional

* stream using the `StreamingPull` method.

*

* <p>This class provides the ability to make remote calls to the backing service through method

* calls that map to API methods. Sample code to get started:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* SubscriptionName name = SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");

* TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* }</pre>

*

* <p>Note: close() needs to be called on the SubscriptionAdminClient object to clean up resources

* such as threads. In the example above, try-with-resources is used, which automatically calls

* close().

*

* <table>

* <caption>Methods</caption>

* <tr>

* <th>Method</th>

* <th>Description</th>

* <th>Method Variants</th>

* </tr>

* <tr>

* <td><p> CreateSubscription</td>

* <td><p> Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.

* <p> If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> createSubscription(Subscription request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> createSubscription(SubscriptionName name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds)

* <li><p> createSubscription(SubscriptionName name, String topic, PushConfig pushConfig, int ackDeadlineSeconds)

* <li><p> createSubscription(String name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds)

* <li><p> createSubscription(String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> createSubscriptionCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> GetSubscription</td>

* <td><p> Gets the configuration details of a subscription.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> getSubscription(GetSubscriptionRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> getSubscription(SubscriptionName subscription)

* <li><p> getSubscription(String subscription)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> getSubscriptionCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> UpdateSubscription</td>

* <td><p> Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> updateSubscription(UpdateSubscriptionRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> updateSubscription(Subscription subscription, FieldMask updateMask)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> updateSubscriptionCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> ListSubscriptions</td>

* <td><p> Lists matching subscriptions.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> listSubscriptions(ListSubscriptionsRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> listSubscriptions(ProjectName project)

* <li><p> listSubscriptions(String project)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> listSubscriptionsPagedCallable()

* <li><p> listSubscriptionsCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> DeleteSubscription</td>

* <td><p> Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> deleteSubscription(DeleteSubscriptionRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> deleteSubscription(SubscriptionName subscription)

* <li><p> deleteSubscription(String subscription)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> deleteSubscriptionCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> ModifyAckDeadline</td>

* <td><p> Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> modifyAckDeadline(ModifyAckDeadlineRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> modifyAckDeadline(SubscriptionName subscription, List&lt;String&gt; ackIds, int ackDeadlineSeconds)

* <li><p> modifyAckDeadline(String subscription, List&lt;String&gt; ackIds, int ackDeadlineSeconds)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> modifyAckDeadlineCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> Acknowledge</td>

* <td><p> Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription.

* <p> Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> acknowledge(AcknowledgeRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> acknowledge(SubscriptionName subscription, List&lt;String&gt; ackIds)

* <li><p> acknowledge(String subscription, List&lt;String&gt; ackIds)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> acknowledgeCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> Pull</td>

* <td><p> Pulls messages from the server.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> pull(PullRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> pull(SubscriptionName subscription, int maxMessages)

* <li><p> pull(String subscription, int maxMessages)

* <li><p> pull(SubscriptionName subscription, boolean returnImmediately, int maxMessages)

* <li><p> pull(String subscription, boolean returnImmediately, int maxMessages)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> pullCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> StreamingPull</td>

* <td><p> Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgments and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status `UNAVAILABLE` to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.</td>

* <td>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> streamingPullCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> ModifyPushConfig</td>

* <td><p> Modifies the `PushConfig` for a specified subscription.

* <p> This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> modifyPushConfig(ModifyPushConfigRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> modifyPushConfig(SubscriptionName subscription, PushConfig pushConfig)

* <li><p> modifyPushConfig(String subscription, PushConfig pushConfig)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> modifyPushConfigCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> GetSnapshot</td>

* <td><p> Gets the configuration details of a snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> getSnapshot(GetSnapshotRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> getSnapshot(SnapshotName snapshot)

* <li><p> getSnapshot(String snapshot)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> getSnapshotCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> ListSnapshots</td>

* <td><p> Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> listSnapshots(ListSnapshotsRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> listSnapshots(ProjectName project)

* <li><p> listSnapshots(String project)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> listSnapshotsPagedCallable()

* <li><p> listSnapshotsCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> CreateSnapshot</td>

* <td><p> Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> createSnapshot(CreateSnapshotRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> createSnapshot(SnapshotName name, SubscriptionName subscription)

* <li><p> createSnapshot(SnapshotName name, String subscription)

* <li><p> createSnapshot(String name, SubscriptionName subscription)

* <li><p> createSnapshot(String name, String subscription)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> createSnapshotCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> UpdateSnapshot</td>

* <td><p> Updates an existing snapshot by updating the fields specified in the update mask. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> updateSnapshot(UpdateSnapshotRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> updateSnapshot(Snapshot snapshot, FieldMask updateMask)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> updateSnapshotCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> DeleteSnapshot</td>

* <td><p> Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> deleteSnapshot(DeleteSnapshotRequest request)

* </ul>

* <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>

* <ul>

* <li><p> deleteSnapshot(SnapshotName snapshot)

* <li><p> deleteSnapshot(String snapshot)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> deleteSnapshotCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> Seek</td>

* <td><p> Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> seek(SeekRequest request)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> seekCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> SetIamPolicy</td>

* <td><p> Sets the access control policy on the specified resource. Replacesany existing policy.

* <p> Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> setIamPolicy(SetIamPolicyRequest request)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> setIamPolicyCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> GetIamPolicy</td>

* <td><p> Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> getIamPolicy(GetIamPolicyRequest request)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> getIamPolicyCallable()

* </ul>

* </td>

* </tr>

* <tr>

* <td><p> TestIamPermissions</td>

* <td><p> Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

* <p> Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.</td>

* <td>

* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>

* <ul>

* <li><p> testIamPermissions(TestIamPermissionsRequest request)

* </ul>

* <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>

* <ul>

* <li><p> testIamPermissionsCallable()

* </ul>

* </td>

* </tr>

* </table>

*

* <p>See the individual methods for example code.

*

* <p>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 parse

* method to extract the individual identifiers contained within names that are returned.

*

* <p>This class can be customized by passing in a custom instance of SubscriptionAdminSettings to

* create(). For example:

*

* <p>To customize credentials:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* SubscriptionAdminSettings subscriptionAdminSettings =

* SubscriptionAdminSettings.newBuilder()

* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))

* .build();

* SubscriptionAdminClient subscriptionAdminClient =

* SubscriptionAdminClient.create(subscriptionAdminSettings);

* }</pre>

*

* <p>To customize the endpoint:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* SubscriptionAdminSettings subscriptionAdminSettings =

* SubscriptionAdminSettings.newBuilder().setEndpoint(myEndpoint).build();

* SubscriptionAdminClient subscriptionAdminClient =

* SubscriptionAdminClient.create(subscriptionAdminSettings);

* }</pre>

*

* <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over

* the wire:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* SubscriptionAdminSettings subscriptionAdminSettings =

* SubscriptionAdminSettings.newHttpJsonBuilder().build();

* SubscriptionAdminClient subscriptionAdminClient =

* SubscriptionAdminClient.create(subscriptionAdminSettings);

* }</pre>

*

* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.

*/

@NullMarked

@Generated("by gapic-generator-java")

public class SubscriptionAdminClient implements BackgroundResource {

private final @Nullable SubscriptionAdminSettings settings;

private final SubscriberStub stub;

/** Constructs an instance of SubscriptionAdminClient with default settings. */

public static final SubscriptionAdminClient create() throws IOException {

return create(SubscriptionAdminSettings.newBuilder().build());

}

/**

* Constructs an instance of SubscriptionAdminClient, using the given settings. The channels are

* created based on the settings passed in, or defaults for any settings that are not set.

*/

public static final SubscriptionAdminClient create(SubscriptionAdminSettings settings)

throws IOException {

return new SubscriptionAdminClient(settings);

}

/**

* Constructs an instance of SubscriptionAdminClient, using the given stub for making calls. This

* is for advanced usage - prefer using create(SubscriptionAdminSettings).

*/

public static final SubscriptionAdminClient create(SubscriberStub stub) {

return new SubscriptionAdminClient(stub);

}

/**

* Constructs an instance of SubscriptionAdminClient, using the given settings. This is protected

* so that it is easy to make a subclass, but otherwise, the static factory methods should be

* preferred.

*/

protected SubscriptionAdminClient(SubscriptionAdminSettings settings) throws IOException {

this.settings = settings;

this.stub = ((SubscriberStubSettings) settings.getStubSettings()).createStub();

}

protected SubscriptionAdminClient(SubscriberStub stub) {

this.settings = null;

this.stub = stub;

}

public final @Nullable SubscriptionAdminSettings getSettings() {

return settings;

}

public SubscriberStub getStub() {

return stub;

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription

* already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* SubscriptionName name = SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");

* TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* }</pre>

*

* @param name Required. Identifier. The name of the subscription. It must have the format

* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a

* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores

* (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3

* and 255 characters in length, and it must not start with `"goog"`.

* @param topic Required. The name of the topic from which this subscription is receiving

* messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be

* `_deleted-topic_` if the topic has been deleted.

* @param pushConfig Optional. If push delivery is used with this subscription, this field is used

* to configure it.

* @param ackDeadlineSeconds Optional. The approximate amount of time (on a best-effort basis)

* Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In

* the interval after the message is delivered and before it is acknowledged, it is considered

* to be _outstanding_. During that time period, the message will not be redelivered (on a

* best-effort basis).

* <p>For pull subscriptions, this value is used as the initial value for the ack deadline. To

* override this value for a given message, call `ModifyAckDeadline` with the corresponding

* `ack_id` if using non-streaming pull or send the `ack_id` in a

* `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline

* you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds

* (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

* <p>For push delivery, this value is also used to set the request timeout for the call to

* the push endpoint.

* <p>If the subscriber never acknowledges the message, the Pub/Sub system will eventually

* redeliver the message.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

*/

public final Subscription createSubscription(

@Nullable SubscriptionName name,

@Nullable TopicName topic,

PushConfig pushConfig,

int ackDeadlineSeconds) {

Subscription request =

Subscription.newBuilder()

.setName(name == null ? null : name.toString())

.setTopic(topic == null ? null : topic.toString())

.setPushConfig(pushConfig)

.setAckDeadlineSeconds(ackDeadlineSeconds)

.build();

return createSubscription(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription

* already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* SubscriptionName name = SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");

* String topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]").toString();

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* }</pre>

*

* @param name Required. Identifier. The name of the subscription. It must have the format

* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a

* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores

* (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3

* and 255 characters in length, and it must not start with `"goog"`.

* @param topic Required. The name of the topic from which this subscription is receiving

* messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be

* `_deleted-topic_` if the topic has been deleted.

* @param pushConfig Optional. If push delivery is used with this subscription, this field is used

* to configure it.

* @param ackDeadlineSeconds Optional. The approximate amount of time (on a best-effort basis)

* Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In

* the interval after the message is delivered and before it is acknowledged, it is considered

* to be _outstanding_. During that time period, the message will not be redelivered (on a

* best-effort basis).

* <p>For pull subscriptions, this value is used as the initial value for the ack deadline. To

* override this value for a given message, call `ModifyAckDeadline` with the corresponding

* `ack_id` if using non-streaming pull or send the `ack_id` in a

* `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline

* you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds

* (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

* <p>For push delivery, this value is also used to set the request timeout for the call to

* the push endpoint.

* <p>If the subscriber never acknowledges the message, the Pub/Sub system will eventually

* redeliver the message.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

*/

public final Subscription createSubscription(

@Nullable SubscriptionName name,

String topic,

PushConfig pushConfig,

int ackDeadlineSeconds) {

Subscription request =

Subscription.newBuilder()

.setName(name == null ? null : name.toString())

.setTopic(topic)

.setPushConfig(pushConfig)

.setAckDeadlineSeconds(ackDeadlineSeconds)

.build();

return createSubscription(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription

* already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* String name = SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]").toString();

* TopicName topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]");

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* }</pre>

*

* @param name Required. Identifier. The name of the subscription. It must have the format

* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a

* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores

* (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3

* and 255 characters in length, and it must not start with `"goog"`.

* @param topic Required. The name of the topic from which this subscription is receiving

* messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be

* `_deleted-topic_` if the topic has been deleted.

* @param pushConfig Optional. If push delivery is used with this subscription, this field is used

* to configure it.

* @param ackDeadlineSeconds Optional. The approximate amount of time (on a best-effort basis)

* Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In

* the interval after the message is delivered and before it is acknowledged, it is considered

* to be _outstanding_. During that time period, the message will not be redelivered (on a

* best-effort basis).

* <p>For pull subscriptions, this value is used as the initial value for the ack deadline. To

* override this value for a given message, call `ModifyAckDeadline` with the corresponding

* `ack_id` if using non-streaming pull or send the `ack_id` in a

* `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline

* you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds

* (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

* <p>For push delivery, this value is also used to set the request timeout for the call to

* the push endpoint.

* <p>If the subscriber never acknowledges the message, the Pub/Sub system will eventually

* redeliver the message.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

*/

public final Subscription createSubscription(

String name, @Nullable TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds) {

Subscription request =

Subscription.newBuilder()

.setName(name)

.setTopic(topic == null ? null : topic.toString())

.setPushConfig(pushConfig)

.setAckDeadlineSeconds(ackDeadlineSeconds)

.build();

return createSubscription(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription

* already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* String name = SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]").toString();

* String topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]").toString();

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* }</pre>

*

* @param name Required. Identifier. The name of the subscription. It must have the format

* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a

* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores

* (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3

* and 255 characters in length, and it must not start with `"goog"`.

* @param topic Required. The name of the topic from which this subscription is receiving

* messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be

* `_deleted-topic_` if the topic has been deleted.

* @param pushConfig Optional. If push delivery is used with this subscription, this field is used

* to configure it.

* @param ackDeadlineSeconds Optional. The approximate amount of time (on a best-effort basis)

* Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In

* the interval after the message is delivered and before it is acknowledged, it is considered

* to be _outstanding_. During that time period, the message will not be redelivered (on a

* best-effort basis).

* <p>For pull subscriptions, this value is used as the initial value for the ack deadline. To

* override this value for a given message, call `ModifyAckDeadline` with the corresponding

* `ack_id` if using non-streaming pull or send the `ack_id` in a

* `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline

* you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds

* (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

* <p>For push delivery, this value is also used to set the request timeout for the call to

* the push endpoint.

* <p>If the subscriber never acknowledges the message, the Pub/Sub system will eventually

* redeliver the message.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

*/

public final Subscription createSubscription(

String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) {

Subscription request =

Subscription.newBuilder()

.setName(name)

.setTopic(topic)

.setPushConfig(pushConfig)

.setAckDeadlineSeconds(ackDeadlineSeconds)

.build();

return createSubscription(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the subscription

* already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre>{@code

* // This snippet 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 as shown in

* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* Subscription request =

* Subscription.newBuilder()

* .setName(SubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]").toString())

* .setTopic(TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]").toString())

* .setPushConfig(PushConfig.newBuilder().build())

* .setBigqueryConfig(BigQueryConfig.newBuilder().build())

* .setCloudStorageConfig(CloudStorageConfig.newBuilder().build())

* .setBigtableConfig(BigtableConfig.newBuilder().build())

* .setAckDeadlineSeconds(2135351438)

* .setRetainAckedMessages(true)

* .setMessageRetentionDuration(Duration.newBuilder().build())

* .putAllLabels(new HashMap<String, String>())

* .setEnableMessageOrdering(true)

* .setExpirationPolicy(ExpirationPolicy.newBuilder().build())

* .setFilter("filter-1274492040")

* .setDeadLetterPolicy(DeadLetterPolicy.newBuilder().build())

* .setRetryPolicy(RetryPolicy.newBuilder().build())

* .setDetached(true)

* .setEnableExactlyOnceDelivery(true)

* .setTopicMessageRetentionDuration(Duration.newBuilder().build())

* .setAnalyticsHubSubscriptionInfo(

* Subscription.AnalyticsHubSubscriptionInfo.newBuilder().build())

* .addAllMessageTransforms(new ArrayList<MessageTransform>())

* .putAllTags(new HashMap<String, String>())

* .build();

* Subscription response = subscriptionAdminClient.createSubscription(request);

* }

* }</pre>

*

* @param request The request object containing all of the parameters for the API call.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

*/

public final Subscription createSubscription(Subscription request) {

return createSubscriptionCallable().call(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD

/**

* Creates a subscription to a given topic. See the &lt;a

* href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource name

* rules&lt;/a&gt;. If the subscription already exists, returns `ALREADY_EXISTS`. If the

* corresponding topic doesn't exist, returns `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name

* format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is

* populated in the returned Subscription object. Note that for REST API requests, you must

* specify a name in the request.

*

* <p>Sample code:

*

* <pre><code>

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");

* ProjectTopicName topic = ProjectTopicName.of("[PROJECT]", "[TOPIC]");

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 0;

* Subscription response = subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);

* }

* </code></pre>

*

* @param name Required. The name of the subscription. It must have the format

* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a

* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores

* (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3

* and 255 characters in length, and it must not start with `"goog"`.

* @param topic Required. The name of the topic from which this subscription is receiving

* messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be

* `_deleted-topic_` if the topic has been deleted.

* @param pushConfig If push delivery is used with this subscription, this field is used to

* configure it. An empty `pushConfig` signifies that the subscriber will pull and ack

* messages using API methods.

* @param ackDeadlineSeconds The approximate amount of time (on a best-effort basis) Pub/Sub waits

* for the subscriber to acknowledge receipt before resending the message. In the interval

* after the message is delivered and before it is acknowledged, it is considered to be

* &lt;i&gt;outstanding&lt;/i&gt;. During that time period, the message will not be

* redelivered (on a best-effort basis).

* <p>For pull subscriptions, this value is used as the initial value for the ack deadline. To

* override this value for a given message, call `ModifyAckDeadline` with the corresponding

* `ack_id` if using non-streaming pull or send the `ack_id` in a

* `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline

* you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds

* (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

* <p>For push delivery, this value is also used to set the request timeout for the call to

* the push endpoint.

* <p>If the subscriber never acknowledges the message, the Pub/Sub system will eventually

* redeliver the message.

* @throws com.google.api.gax.rpc.ApiException if the remote call fails

* @deprecated Use {@link #createSubscription(SubscriptionName, TopicName, PushConfig, int)}

* instead.

*/

@Deprecated

public final Subscription createSubscription(

ProjectSubscriptionName name,

ProjectTopicName topic,

PushConfig pushConfig,

int ackDeadlineSeconds) {

Subscription request =

Subscription.newBuilder()

.setName(name == null ? null : name.toString())

.setTopic(topic == null ? null : topic.toString())

.setPushConfig(pushConfig)

.setAckDeadlineSeconds(ackDeadlineSeconds)

.build();

return createSubscription(request);

}

// AUTO-GENERATED DOCUMENTATION AND METHOD.

/**

* Creates a subscription to a given topic. See the [resource name rules]

* (https://cloud.google.com/pubsub/docs/admin#resource_names). If the subscription already

* exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns

* `NOT_FOUND`.

*

* <p>If the name is not provided in the request, the server will assign a random name for this

* subscription on the same project as the topic, conforming to the [resource name format]

* (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in

* the returned Subscription object. Note that for REST API requests, you must specify a name in

* the request.

*

* <p>Sample code:

*

* <pre>{@code

* try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

* ProjectSubscriptionName name = ProjectSubscriptionName.of("[PROJECT]", "[SUBSCRIPTION]");

* String topic = TopicName.ofProjectTopicName("[PROJECT]", "[TOPIC]").toString();

* PushConfig pushConfig = PushConfig.newBuilder().build();

* int ackDeadlineSeconds = 2135351438;

* Subscription response =

* subscriptionAdminClient.createSubscription(name, topic, pushConfig, ackDeadlineSeconds);