Class CreateSubscriptionRequest (1.12.7)

public final class CreateSubscriptionRequest extends GeneratedMessageV3 implements CreateSubscriptionRequestOrBuilder

Request for CreateSubscription.

Protobuf type google.cloud.pubsublite.v1.CreateSubscriptionRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

SKIP_BACKLOG_FIELD_NUMBER

public static final int SKIP_BACKLOG_FIELD_NUMBER
Field Value
TypeDescription
int

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

SUBSCRIPTION_ID_FIELD_NUMBER

public static final int SUBSCRIPTION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateSubscriptionRequest getDefaultInstance()
Returns
TypeDescription
CreateSubscriptionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateSubscriptionRequest.Builder newBuilder()
Returns
TypeDescription
CreateSubscriptionRequest.Builder

newBuilder(CreateSubscriptionRequest prototype)

public static CreateSubscriptionRequest.Builder newBuilder(CreateSubscriptionRequest prototype)
Parameter
NameDescription
prototypeCreateSubscriptionRequest
Returns
TypeDescription
CreateSubscriptionRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateSubscriptionRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateSubscriptionRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateSubscriptionRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateSubscriptionRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateSubscriptionRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateSubscriptionRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateSubscriptionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateSubscriptionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateSubscriptionRequest> parser()
Returns
TypeDescription
Parser<CreateSubscriptionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateSubscriptionRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateSubscriptionRequest

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateSubscriptionRequest> getParserForType()
Returns
TypeDescription
Parser<CreateSubscriptionRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSkipBacklog()

public 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
TypeDescription
boolean

The skipBacklog.

getSubscription()

public 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
TypeDescription
Subscription

The subscription.

getSubscriptionId()

public 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
TypeDescription
String

The subscriptionId.

getSubscriptionIdBytes()

public 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
TypeDescription
ByteString

The bytes for subscriptionId.

getSubscriptionOrBuilder()

public 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];

Returns
TypeDescription
SubscriptionOrBuilder

hasSubscription()

public 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
TypeDescription
boolean

Whether the subscription field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateSubscriptionRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateSubscriptionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateSubscriptionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateSubscriptionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateSubscriptionRequest.Builder toBuilder()
Returns
TypeDescription
CreateSubscriptionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException