public final class WebhookNotification extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CHANNEL_TOKEN_FIELD_NUMBER
public static final int CHANNEL_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static WebhookNotification getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WebhookNotification.Builder newBuilder()
newBuilder(WebhookNotification prototype)
public static WebhookNotification.Builder newBuilder(WebhookNotification prototype)
public static WebhookNotification parseDelimitedFrom(InputStream input)
public static WebhookNotification parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WebhookNotification parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WebhookNotification parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WebhookNotification parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WebhookNotification parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WebhookNotification parseFrom(CodedInputStream input)
public static WebhookNotification parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WebhookNotification parseFrom(InputStream input)
public static WebhookNotification parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WebhookNotification parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WebhookNotification parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WebhookNotification> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
| Returns |
| Type |
Description |
String |
The channelToken.
|
getChannelTokenBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for channelToken.
|
getDefaultInstanceForType()
public WebhookNotification getDefaultInstanceForType()
getParserForType()
public Parser<WebhookNotification> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
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];
| Returns |
| Type |
Description |
String |
The uri.
|
getUriBytes()
public 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.
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];
| Returns |
| Type |
Description |
ByteString |
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];
| Returns |
| Type |
Description |
boolean |
Whether the channelToken field is set.
|
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.
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];
| Returns |
| Type |
Description |
boolean |
Whether the uri field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WebhookNotification.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WebhookNotification.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public WebhookNotification.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
