final class PushConfig extends GeneratedMessageV3 with PushConfigOrBuilder
Configuration for a push delivery endpoint.
Protobuf type google.pubsub.v1.PushConfig
- Source
- PushConfig.java
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- PushConfig
- PushConfigOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
containsAttributes(key: String): Boolean
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
map<string, string> attributes = 2;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
- Definition Classes
- PushConfig → AbstractMessage → Message → AnyRef → Any
-
def
findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
def
getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getAttributes(): Map[String, String]
Use
#getAttributesMap()
instead.Use
#getAttributesMap()
instead.- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getAttributesCount(): Int
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
map<string, string> attributes = 2;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getAttributesMap(): Map[String, String]
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
map<string, string> attributes = 2;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getAttributesOrDefault(key: String, defaultValue: String): String
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
map<string, string> attributes = 2;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getAttributesOrThrow(key: String): String
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
map<string, string> attributes = 2;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getAuthenticationMethodCase(): AuthenticationMethodCase
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getDefaultInstanceForType(): PushConfig
- Definition Classes
- PushConfig → MessageOrBuilder → MessageLiteOrBuilder
-
def
getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
-
def
getOidcToken(): OidcToken
If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
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;
- returns
The oidcToken.
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getOidcTokenOrBuilder(): OidcTokenOrBuilder
If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
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;
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
def
getParserForType(): Parser[PushConfig]
- Definition Classes
- PushConfig → GeneratedMessageV3 → Message → MessageLite
-
def
getPushEndpoint(): String
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
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;
- returns
The pushEndpoint.
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getPushEndpointBytes(): ByteString
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
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;
- returns
The bytes for pushEndpoint.
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
getSerializedSize(): Int
- Definition Classes
- PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
-
final
def
getUnknownFields(): UnknownFieldSet
- Definition Classes
- PushConfig → GeneratedMessageV3 → MessageOrBuilder
-
def
hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
-
def
hasOidcToken(): Boolean
If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
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;
- returns
Whether the oidcToken field is set.
- Definition Classes
- PushConfig → PushConfigOrBuilder
-
def
hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
-
def
hashCode(): Int
- Definition Classes
- PushConfig → AbstractMessage → Message → AnyRef → Any
-
def
internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[v1]
- Definition Classes
- PushConfig → GeneratedMessageV3
-
def
internalGetMapField(number: Int): MapField
- Attributes
- protected[v1]
- Definition Classes
- PushConfig → GeneratedMessageV3
-
final
def
isInitialized(): Boolean
- Definition Classes
- PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
-
def
mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( ... )
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[v1]
- Definition Classes
- PushConfig → GeneratedMessageV3
-
def
newBuilderForType(): Builder
- Definition Classes
- PushConfig → Message → MessageLite
-
def
newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
-
def
newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[v1]
- Definition Classes
- PushConfig → GeneratedMessageV3
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( classOf[java.io.IOException] )
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toBuilder(): Builder
- Definition Classes
- PushConfig → Message → MessageLite
-
def
toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
-
def
toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
-
final
def
toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws( ... )
-
def
writeTo(output: CodedOutputStream): Unit
- Definition Classes
- PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
-
def
writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws( classOf[java.io.IOException] )