- 2.51.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.13
- 2.2.0
- 2.1.23
public final class PubsubTarget extends GeneratedMessageV3 implements PubsubTargetOrBuilder
Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.
Protobuf type google.cloud.scheduler.v1beta1.PubsubTarget
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PubsubTargetImplements
PubsubTargetOrBuilderStatic Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TOPIC_NAME_FIELD_NUMBER
public static final int TOPIC_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static PubsubTarget getDefaultInstance()
Returns | |
---|---|
Type | Description |
PubsubTarget |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static PubsubTarget.Builder newBuilder()
Returns | |
---|---|
Type | Description |
PubsubTarget.Builder |
newBuilder(PubsubTarget prototype)
public static PubsubTarget.Builder newBuilder(PubsubTarget prototype)
Parameter | |
---|---|
Name | Description |
prototype | PubsubTarget |
Returns | |
---|---|
Type | Description |
PubsubTarget.Builder |
parseDelimitedFrom(InputStream input)
public static PubsubTarget parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static PubsubTarget parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static PubsubTarget parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static PubsubTarget parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static PubsubTarget parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static PubsubTarget parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PubsubTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PubsubTarget |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<PubsubTarget> parser()
Returns | |
---|---|
Type | Description |
Parser<PubsubTarget> |
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getAttributes()
public Map<String,String> getAttributes()
Use #getAttributesMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAttributesCount()
public int getAttributesCount()
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4;
Returns | |
---|---|
Type | Description |
int |
getAttributesMap()
public Map<String,String> getAttributesMap()
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAttributesOrDefault(String key, String defaultValue)
public String getAttributesOrDefault(String key, String defaultValue)
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4;
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getAttributesOrThrow(String key)
public String getAttributesOrThrow(String key)
Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
map<string, string> attributes = 4;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getData()
public ByteString getData()
The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
bytes data = 3;
Returns | |
---|---|
Type | Description |
ByteString | The data. |
getDefaultInstanceForType()
public PubsubTarget getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PubsubTarget |
getParserForType()
public Parser<PubsubTarget> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<PubsubTarget> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getTopicName()
public String getTopicName()
Required. The name of the Cloud Pub/Sub topic to which messages will
be published when a job is delivered. The topic name must be in the
same format as required by Pub/Sub's
PublishRequest.name,
for example projects/PROJECT_ID/topics/TOPIC_ID
.
The topic must be in the same project as the Cloud Scheduler job.
string topic_name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The topicName. |
getTopicNameBytes()
public ByteString getTopicNameBytes()
Required. The name of the Cloud Pub/Sub topic to which messages will
be published when a job is delivered. The topic name must be in the
same format as required by Pub/Sub's
PublishRequest.name,
for example projects/PROJECT_ID/topics/TOPIC_ID
.
The topic must be in the same project as the Cloud Scheduler job.
string topic_name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for topicName. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public PubsubTarget.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
PubsubTarget.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PubsubTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
PubsubTarget.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public PubsubTarget.Builder toBuilder()
Returns | |
---|---|
Type | Description |
PubsubTarget.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |