com.google.cloud.spring.pubsub.support.PubSubSubscriptionUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-gcp-pubsub Show documentation

Spring Framework on Google Cloud Pub/Sub Module

The newest version!

/*
 * Copyright 2017-2019 the original author or authors.
 *
 * 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.spring.pubsub.support;

import com.google.pubsub.v1.ProjectSubscriptionName;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * Various utility methods for dealing with Pub/Sub subscriptions.
 *
 * @since 1.2
 */
public final class PubSubSubscriptionUtils {

  private PubSubSubscriptionUtils() {}

  /**
   * Create a {@link ProjectSubscriptionName} based on a subscription name within a project or the
   * fully-qualified subscription name. If the specified subscription is in the {@code
   * projects/[project_name]/subscriptions/[subscription_name]} format, then the {@code projectId}
   * is ignored.
   *
   * @param subscription the subscription name in the project or the fully-qualified project name
   * @param projectId the project ID to use if the subscription is not a fully-qualified name
   * @return the Pub/Sub object representing the subscription name
   */
  public static ProjectSubscriptionName toProjectSubscriptionName(
      String subscription, @Nullable String projectId) {
    Assert.notNull(subscription, "The subscription can't be null.");

    ProjectSubscriptionName projectSubscriptionName = null;

    if (ProjectSubscriptionName.isParsableFrom(subscription)) {
      // Fully-qualified subscription name in the
      // "projects/[project_name]/subscriptions/[subscription_name]" format
      projectSubscriptionName = ProjectSubscriptionName.parse(subscription);
    } else {
      Assert.notNull(
          projectId, "The project ID can't be null when using canonical subscription name.");
      projectSubscriptionName = ProjectSubscriptionName.of(projectId, subscription);
    }

    return projectSubscriptionName;
  }
}