public static final class PushConfig.Builder extends GeneratedMessageV3.Builder<PushConfig.Builder> implements PushConfigOrBuilderConfiguration for a push delivery endpoint.
Protobuf type google.pubsub.v1.PushConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PushConfig.BuilderImplements
PushConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PushConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
build()
public PushConfig build()| Returns | |
|---|---|
| Type | Description |
PushConfig |
|
buildPartial()
public PushConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
PushConfig |
|
clear()
public PushConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearAttributes()
public PushConfig.Builder clearAttributes()| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearAuthenticationMethod()
public PushConfig.Builder clearAuthenticationMethod()| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PushConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearNoWrapper()
public PushConfig.Builder clearNoWrapper()Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearOidcToken()
public PushConfig.Builder clearOidcToken() Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public PushConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearPubsubWrapper()
public PushConfig.Builder clearPubsubWrapper()Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clearPushEndpoint()
public PushConfig.Builder clearPushEndpoint() Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
This builder for chaining. |
clearWrapper()
public PushConfig.Builder clearWrapper()| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
clone()
public PushConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
containsAttributes(String key)
public boolean containsAttributes(String key)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAttributes() (deprecated)
public Map<String,String> getAttributes()Use #getAttributesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAttributesCount()
public int getAttributesCount()Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAttributesMap()
public Map<String,String> getAttributesMap()Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAttributesOrDefault(String key, String defaultValue)
public String getAttributesOrDefault(String key, String defaultValue)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAttributesOrThrow(String key)
public String getAttributesOrThrow(String key)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAuthenticationMethodCase()
public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()| Returns | |
|---|---|
| Type | Description |
PushConfig.AuthenticationMethodCase |
|
getDefaultInstanceForType()
public PushConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PushConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMutableAttributes() (deprecated)
public Map<String,String> getMutableAttributes()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getNoWrapper()
public PushConfig.NoWrapper getNoWrapper()Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.NoWrapper |
The noWrapper. |
getNoWrapperBuilder()
public PushConfig.NoWrapper.Builder getNoWrapperBuilder()Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.NoWrapper.Builder |
|
getNoWrapperOrBuilder()
public PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.NoWrapperOrBuilder |
|
getOidcToken()
public PushConfig.OidcToken getOidcToken() Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.OidcToken |
The oidcToken. |
getOidcTokenBuilder()
public PushConfig.OidcToken.Builder getOidcTokenBuilder() Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.OidcToken.Builder |
|
getOidcTokenOrBuilder()
public PushConfig.OidcTokenOrBuilder getOidcTokenOrBuilder() Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.OidcTokenOrBuilder |
|
getPubsubWrapper()
public PushConfig.PubsubWrapper getPubsubWrapper()Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.PubsubWrapper |
The pubsubWrapper. |
getPubsubWrapperBuilder()
public PushConfig.PubsubWrapper.Builder getPubsubWrapperBuilder()Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.PubsubWrapper.Builder |
|
getPubsubWrapperOrBuilder()
public PushConfig.PubsubWrapperOrBuilder getPubsubWrapperOrBuilder()Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PushConfig.PubsubWrapperOrBuilder |
|
getPushEndpoint()
public String getPushEndpoint() Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pushEndpoint. |
getPushEndpointBytes()
public ByteString getPushEndpointBytes() Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pushEndpoint. |
getWrapperCase()
public PushConfig.WrapperCase getWrapperCase()| Returns | |
|---|---|
| Type | Description |
PushConfig.WrapperCase |
|
hasNoWrapper()
public boolean hasNoWrapper()Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the noWrapper field is set. |
hasOidcToken()
public boolean hasOidcToken() Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the oidcToken field is set. |
hasPubsubWrapper()
public boolean hasPubsubWrapper()Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pubsubWrapper field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PushConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PushConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
mergeFrom(PushConfig other)
public PushConfig.Builder mergeFrom(PushConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
PushConfig |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
mergeNoWrapper(PushConfig.NoWrapper value)
public PushConfig.Builder mergeNoWrapper(PushConfig.NoWrapper value)Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.NoWrapper |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
mergeOidcToken(PushConfig.OidcToken value)
public PushConfig.Builder mergeOidcToken(PushConfig.OidcToken value) Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.OidcToken |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
mergePubsubWrapper(PushConfig.PubsubWrapper value)
public PushConfig.Builder mergePubsubWrapper(PushConfig.PubsubWrapper value)Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.PubsubWrapper |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PushConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
putAllAttributes(Map<String,String> values)
public PushConfig.Builder putAllAttributes(Map<String,String> values)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
putAttributes(String key, String value)
public PushConfig.Builder putAttributes(String key, String value)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
removeAttributes(String key)
public PushConfig.Builder removeAttributes(String key)Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery.
The only currently supported attribute is x-goog-version, which you can
use to change the format of the pushed message. This attribute
indicates the version of the data expected by the endpoint. This
controls the shape of the pushed message (i.e., its fields and metadata).
If not present during the CreateSubscription call, it will default to
the version of the Pub/Sub API used to make such call. If not present in a
ModifyPushConfig call, its value will not be changed. GetSubscription
calls will always return a valid version, even if the subscription was
created without this attribute.
The only supported values for the x-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PushConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setNoWrapper(PushConfig.NoWrapper value)
public PushConfig.Builder setNoWrapper(PushConfig.NoWrapper value)Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.NoWrapper |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setNoWrapper(PushConfig.NoWrapper.Builder builderForValue)
public PushConfig.Builder setNoWrapper(PushConfig.NoWrapper.Builder builderForValue)Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PushConfig.NoWrapper.Builder |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setOidcToken(PushConfig.OidcToken value)
public PushConfig.Builder setOidcToken(PushConfig.OidcToken value) Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.OidcToken |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setOidcToken(PushConfig.OidcToken.Builder builderForValue)
public PushConfig.Builder setOidcToken(PushConfig.OidcToken.Builder builderForValue) Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for every pushed
message.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PushConfig.OidcToken.Builder |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setPubsubWrapper(PushConfig.PubsubWrapper value)
public PushConfig.Builder setPubsubWrapper(PushConfig.PubsubWrapper value)Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
PushConfig.PubsubWrapper |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setPubsubWrapper(PushConfig.PubsubWrapper.Builder builderForValue)
public PushConfig.Builder setPubsubWrapper(PushConfig.PubsubWrapper.Builder builderForValue)Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PushConfig.PubsubWrapper.Builder |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setPushEndpoint(String value)
public PushConfig.Builder setPushEndpoint(String value) Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pushEndpoint to set. |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
This builder for chaining. |
setPushEndpointBytes(ByteString value)
public PushConfig.Builder setPushEndpointBytes(ByteString value) Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pushEndpoint to set. |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PushConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PushConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PushConfig.Builder |
|