Package com.google.pubsub.v1
Class CreateSnapshotRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
- com.google.pubsub.v1.CreateSnapshotRequest.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,CreateSnapshotRequestOrBuilder
,Cloneable
- Enclosing class:
- CreateSnapshotRequest
public static final class CreateSnapshotRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder> implements CreateSnapshotRequestOrBuilder
Request for the `CreateSnapshot` method.
Protobuf typegoogle.pubsub.v1.CreateSnapshotRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CreateSnapshotRequest.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CreateSnapshotRequest
build()
CreateSnapshotRequest
buildPartial()
CreateSnapshotRequest.Builder
clear()
CreateSnapshotRequest.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
CreateSnapshotRequest.Builder
clearLabels()
CreateSnapshotRequest.Builder
clearName()
Required.CreateSnapshotRequest.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
CreateSnapshotRequest.Builder
clearSubscription()
Required.CreateSnapshotRequest.Builder
clone()
boolean
containsLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).CreateSnapshotRequest
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).Map<String,String>
getLabelsMap()
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).String
getLabelsOrDefault(String key, String defaultValue)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).String
getLabelsOrThrow(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).Map<String,String>
getMutableLabels()
Deprecated.String
getName()
Required.com.google.protobuf.ByteString
getNameBytes()
Required.String
getSubscription()
Required.com.google.protobuf.ByteString
getSubscriptionBytes()
Required.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
protected com.google.protobuf.MapField
internalGetMutableMapField(int number)
boolean
isInitialized()
CreateSnapshotRequest.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
CreateSnapshotRequest.Builder
mergeFrom(com.google.protobuf.Message other)
CreateSnapshotRequest.Builder
mergeFrom(CreateSnapshotRequest other)
CreateSnapshotRequest.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
CreateSnapshotRequest.Builder
putAllLabels(Map<String,String> values)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).CreateSnapshotRequest.Builder
putLabels(String key, String value)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).CreateSnapshotRequest.Builder
removeLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).CreateSnapshotRequest.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CreateSnapshotRequest.Builder
setName(String value)
Required.CreateSnapshotRequest.Builder
setNameBytes(com.google.protobuf.ByteString value)
Required.CreateSnapshotRequest.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
CreateSnapshotRequest.Builder
setSubscription(String value)
Required.CreateSnapshotRequest.Builder
setSubscriptionBytes(com.google.protobuf.ByteString value)
Required.CreateSnapshotRequest.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
clear
public CreateSnapshotRequest.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
getDefaultInstanceForType
public CreateSnapshotRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public CreateSnapshotRequest build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public CreateSnapshotRequest buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public CreateSnapshotRequest.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
setField
public CreateSnapshotRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
clearField
public CreateSnapshotRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
clearOneof
public CreateSnapshotRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
setRepeatedField
public CreateSnapshotRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
addRepeatedField
public CreateSnapshotRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
mergeFrom
public CreateSnapshotRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<CreateSnapshotRequest.Builder>
-
mergeFrom
public CreateSnapshotRequest.Builder mergeFrom(CreateSnapshotRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
mergeFrom
public CreateSnapshotRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<CreateSnapshotRequest.Builder>
- Throws:
IOException
-
getName
public String getName()
Required. User-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getName
in interfaceCreateSnapshotRequestOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Required. User-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getNameBytes
in interfaceCreateSnapshotRequestOrBuilder
- Returns:
- The bytes for name.
-
setName
public CreateSnapshotRequest.Builder setName(String value)
Required. User-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
public CreateSnapshotRequest.Builder clearName()
Required. User-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Returns:
- This builder for chaining.
-
setNameBytes
public CreateSnapshotRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
Required. User-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. See the [resource name rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format is `projects/{project}/snapshots/{snap}`.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getSubscription
public String getSubscription()
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getSubscription
in interfaceCreateSnapshotRequestOrBuilder
- Returns:
- The subscription.
-
getSubscriptionBytes
public com.google.protobuf.ByteString getSubscriptionBytes()
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getSubscriptionBytes
in interfaceCreateSnapshotRequestOrBuilder
- Returns:
- The bytes for subscription.
-
setSubscription
public CreateSnapshotRequest.Builder setSubscription(String value)
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Parameters:
value
- The subscription to set.- Returns:
- This builder for chaining.
-
clearSubscription
public CreateSnapshotRequest.Builder clearSubscription()
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Returns:
- This builder for chaining.
-
setSubscriptionBytes
public CreateSnapshotRequest.Builder setSubscriptionBytes(com.google.protobuf.ByteString value)
Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.
string subscription = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Parameters:
value
- The bytes for subscription to set.- Returns:
- This builder for chaining.
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:CreateSnapshotRequestOrBuilder
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
- Specified by:
getLabelsCount
in interfaceCreateSnapshotRequestOrBuilder
-
containsLabels
public boolean containsLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
- Specified by:
containsLabels
in interfaceCreateSnapshotRequestOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceCreateSnapshotRequestOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
- Specified by:
getLabelsMap
in interfaceCreateSnapshotRequestOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
- Specified by:
getLabelsOrDefault
in interfaceCreateSnapshotRequestOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
- Specified by:
getLabelsOrThrow
in interfaceCreateSnapshotRequestOrBuilder
-
clearLabels
public CreateSnapshotRequest.Builder clearLabels()
-
removeLabels
public CreateSnapshotRequest.Builder removeLabels(String key)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
-
getMutableLabels
@Deprecated public Map<String,String> getMutableLabels()
Deprecated.Use alternate mutation accessors instead.
-
putLabels
public CreateSnapshotRequest.Builder putLabels(String key, String value)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
-
putAllLabels
public CreateSnapshotRequest.Builder putAllLabels(Map<String,String> values)
See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 3;
-
setUnknownFields
public final CreateSnapshotRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
mergeUnknownFields
public final CreateSnapshotRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<CreateSnapshotRequest.Builder>
-
-