Package com.google.cloud.pubsublite.proto

Interface CreateSubscriptionRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateSubscriptionRequest, CreateSubscriptionRequest.Builder
public interface CreateSubscriptionRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    boolean
    getSkipBacklog()
    If true, the newly created subscription will only receive messages published after the subscription was created.
    Subscription
    getSubscription()
    Required.
    String
    getSubscriptionId()
    Required.
    com.google.protobuf.ByteString
    getSubscriptionIdBytes()
    Required.
    SubscriptionOrBuilder
    getSubscriptionOrBuilder()
    Required.
    boolean
    hasSubscription()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The parent location in which to create the subscription.
 Structured like `projects/{project_number}/locations/{location}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent location in which to create the subscription.
 Structured like `projects/{project_number}/locations/{location}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • hasSubscription

      boolean hasSubscription()
       Required. Configuration of the subscription to create. Its `name` field is
 ignored.
      .google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the subscription field is set.

    • getSubscription

      Subscription getSubscription()
       Required. Configuration of the subscription to create. Its `name` field is
 ignored.
      .google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The subscription.

    • getSubscriptionOrBuilder

      SubscriptionOrBuilder getSubscriptionOrBuilder()
       Required. Configuration of the subscription to create. Its `name` field is
 ignored.
      .google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];

    • getSubscriptionId

      String getSubscriptionId()
       Required. The ID to use for the subscription, which will become the final
 component of the subscription's name.

 This value is structured like: `my-sub-name`.
      string subscription_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The subscriptionId.

    • getSubscriptionIdBytes

      com.google.protobuf.ByteString getSubscriptionIdBytes()
       Required. The ID to use for the subscription, which will become the final
 component of the subscription's name.

 This value is structured like: `my-sub-name`.
      string subscription_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for subscriptionId.

    • getSkipBacklog

      boolean getSkipBacklog()
       If true, the newly created subscription will only receive messages
 published after the subscription was created. Otherwise, the entire
 message backlog will be received on the subscription. Defaults to false.
      bool skip_backlog = 4;
      Returns:
      The skipBacklog.