com.google.analytics.data.v1alpha

Class WebhookNotification

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.WebhookNotification

All Implemented Interfaces:

WebhookNotificationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class WebhookNotification
extends com.google.protobuf.GeneratedMessageV3
implements WebhookNotificationOrBuilder

 Configures a long-running operation resource to send a webhook notification
 from the Google Analytics Data API to your webhook server when the resource
 updates.

 Notification configurations contain private values & are only visible to your
 GCP project. Different GCP projects may attach different webhook
 notifications to the same long-running operation resource.
 

Protobuf type google.analytics.data.v1alpha.WebhookNotification

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookNotification.Builder Configures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANNEL_TOKEN_FIELD_NUMBER
static int	URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getChannelToken() Optional.
com.google.protobuf.ByteString	getChannelTokenBytes() Optional.
static WebhookNotification	getDefaultInstance()
WebhookNotification	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<WebhookNotification>	getParserForType()
int	getSerializedSize()
String	getUri() Optional.
com.google.protobuf.ByteString	getUriBytes() Optional.
boolean	hasChannelToken() Optional.
int	hashCode()
boolean	hasUri() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static WebhookNotification.Builder	newBuilder()
static WebhookNotification.Builder	newBuilder(WebhookNotification prototype)
WebhookNotification.Builder	newBuilderForType()
protected WebhookNotification.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static WebhookNotification	parseDelimitedFrom(InputStream input)
static WebhookNotification	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebhookNotification	parseFrom(byte[] data)
static WebhookNotification	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebhookNotification	parseFrom(ByteBuffer data)
static WebhookNotification	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebhookNotification	parseFrom(com.google.protobuf.ByteString data)
static WebhookNotification	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebhookNotification	parseFrom(com.google.protobuf.CodedInputStream input)
static WebhookNotification	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WebhookNotification	parseFrom(InputStream input)
static WebhookNotification	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<WebhookNotification>	parser()
WebhookNotification.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

See Also:

Constant Field Values

CHANNEL_TOKEN_FIELD_NUMBER

public static final int CHANNEL_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasUri

public boolean hasUri()

 Optional. The web address that will receive the webhook notification. This
 address will receive POST requests as the state of the long running
 operation resource changes. The POST request will contain both a JSON
 version of the long running operation resource in the body and a
 `sentTimestamp` field. The sent timestamp will specify the unix
 microseconds since the epoch that the request was sent; this lets you
 identify replayed notifications.

 An example URI is
 `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`.

 The URI must use HTTPS and point to a site with a valid SSL certificate on
 the web server. The URI must have a maximum string length of 128 characters
 & use only the allowlisted characters from [RFC
 1738](https://www.rfc-editor.org/rfc/rfc1738).

 When your webhook server receives a notification, it is expected to reply
 with an HTTP response status code of 200 within 5 seconds.

 A URI is required to use webhook notifications.

 Requests to this webhook server will contain an ID token authenticating the
 service account
 `google-analytics-audience-export@system.gserviceaccount.com`. To learn
 more about ID tokens, see
 https://cloud.google.com/docs/authentication/token-types#id. For Google
 Cloud Functions, this lets you configure your function to require
 authentication. In Cloud IAM, you will need to grant the service account
 permissions to the Cloud Run Invoker (`roles/run.invoker`) & Cloud
 Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook
 post request to pass Google Cloud Functions authentication. This API can
 send webhook notifications to arbitrary URIs; for webhook servers other
 than Google Cloud Functions, this ID token in the authorization bearer
 header should be ignored if it is not needed.
 

optional string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasUri in interface WebhookNotificationOrBuilder

Returns:

Whether the uri field is set.

getUri

public String getUri()

 Optional. The web address that will receive the webhook notification. This
 address will receive POST requests as the state of the long running
 operation resource changes. The POST request will contain both a JSON
 version of the long running operation resource in the body and a
 `sentTimestamp` field. The sent timestamp will specify the unix
 microseconds since the epoch that the request was sent; this lets you
 identify replayed notifications.

 An example URI is
 `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`.

 The URI must use HTTPS and point to a site with a valid SSL certificate on
 the web server. The URI must have a maximum string length of 128 characters
 & use only the allowlisted characters from [RFC
 1738](https://www.rfc-editor.org/rfc/rfc1738).

 When your webhook server receives a notification, it is expected to reply
 with an HTTP response status code of 200 within 5 seconds.

 A URI is required to use webhook notifications.

 Requests to this webhook server will contain an ID token authenticating the
 service account
 `google-analytics-audience-export@system.gserviceaccount.com`. To learn
 more about ID tokens, see
 https://cloud.google.com/docs/authentication/token-types#id. For Google
 Cloud Functions, this lets you configure your function to require
 authentication. In Cloud IAM, you will need to grant the service account
 permissions to the Cloud Run Invoker (`roles/run.invoker`) & Cloud
 Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook
 post request to pass Google Cloud Functions authentication. This API can
 send webhook notifications to arbitrary URIs; for webhook servers other
 than Google Cloud Functions, this ID token in the authorization bearer
 header should be ignored if it is not needed.
 

optional string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUri in interface WebhookNotificationOrBuilder

Returns:

The uri.

getUriBytes

public com.google.protobuf.ByteString getUriBytes()

 Optional. The web address that will receive the webhook notification. This
 address will receive POST requests as the state of the long running
 operation resource changes. The POST request will contain both a JSON
 version of the long running operation resource in the body and a
 `sentTimestamp` field. The sent timestamp will specify the unix
 microseconds since the epoch that the request was sent; this lets you
 identify replayed notifications.

 An example URI is
 `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`.

 The URI must use HTTPS and point to a site with a valid SSL certificate on
 the web server. The URI must have a maximum string length of 128 characters
 & use only the allowlisted characters from [RFC
 1738](https://www.rfc-editor.org/rfc/rfc1738).

 When your webhook server receives a notification, it is expected to reply
 with an HTTP response status code of 200 within 5 seconds.

 A URI is required to use webhook notifications.

 Requests to this webhook server will contain an ID token authenticating the
 service account
 `google-analytics-audience-export@system.gserviceaccount.com`. To learn
 more about ID tokens, see
 https://cloud.google.com/docs/authentication/token-types#id. For Google
 Cloud Functions, this lets you configure your function to require
 authentication. In Cloud IAM, you will need to grant the service account
 permissions to the Cloud Run Invoker (`roles/run.invoker`) & Cloud
 Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook
 post request to pass Google Cloud Functions authentication. This API can
 send webhook notifications to arbitrary URIs; for webhook servers other
 than Google Cloud Functions, this ID token in the authorization bearer
 header should be ignored if it is not needed.
 

optional string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUriBytes in interface WebhookNotificationOrBuilder

Returns:

The bytes for uri.

hasChannelToken

public boolean hasChannelToken()

 Optional. The channel token is an arbitrary string value and must have a
 maximum string length of 64 characters. Channel tokens allow you to verify
 the source of a webhook notification. This guards against the message being
 spoofed. The channel token will be specified in the `X-Goog-Channel-Token`
 HTTP header of the webhook POST request.

 A channel token is not required to use webhook notifications.
 

optional string channel_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasChannelToken in interface WebhookNotificationOrBuilder

Returns:

Whether the channelToken field is set.

getChannelToken

public String getChannelToken()

 Optional. The channel token is an arbitrary string value and must have a
 maximum string length of 64 characters. Channel tokens allow you to verify
 the source of a webhook notification. This guards against the message being
 spoofed. The channel token will be specified in the `X-Goog-Channel-Token`
 HTTP header of the webhook POST request.

 A channel token is not required to use webhook notifications.
 

optional string channel_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getChannelToken in interface WebhookNotificationOrBuilder

Returns:

The channelToken.

getChannelTokenBytes

public com.google.protobuf.ByteString getChannelTokenBytes()

 Optional. The channel token is an arbitrary string value and must have a
 maximum string length of 64 characters. Channel tokens allow you to verify
 the source of a webhook notification. This guards against the message being
 spoofed. The channel token will be specified in the `X-Goog-Channel-Token`
 HTTP header of the webhook POST request.

 A channel token is not required to use webhook notifications.
 

optional string channel_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getChannelTokenBytes in interface WebhookNotificationOrBuilder

Returns:

The bytes for channelToken.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static WebhookNotification parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WebhookNotification parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static WebhookNotification parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static WebhookNotification parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static WebhookNotification parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static WebhookNotification parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static WebhookNotification parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public WebhookNotification.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static WebhookNotification.Builder newBuilder()

newBuilder

public static WebhookNotification.Builder newBuilder(WebhookNotification prototype)

toBuilder

public WebhookNotification.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected WebhookNotification.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static WebhookNotification getDefaultInstance()

parser

public static com.google.protobuf.Parser<WebhookNotification> parser()

getParserForType

public com.google.protobuf.Parser<WebhookNotification> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public WebhookNotification getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder