public static final class WebhookNotification.Builder extends GeneratedMessageV3.Builder<WebhookNotification.Builder> implements WebhookNotificationOrBuilderConfigures 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WebhookNotification.BuilderImplements
WebhookNotificationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WebhookNotification.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
build()
public WebhookNotification build()| Returns | |
|---|---|
| Type | Description |
WebhookNotification | |
buildPartial()
public WebhookNotification buildPartial()| Returns | |
|---|---|
| Type | Description |
WebhookNotification | |
clear()
public WebhookNotification.Builder clear()| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
clearChannelToken()
public WebhookNotification.Builder clearChannelToken() 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 |
WebhookNotification.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public WebhookNotification.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public WebhookNotification.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
clearUri()
public WebhookNotification.Builder clearUri() 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 |
WebhookNotification.Builder | This builder for chaining. |
clone()
public WebhookNotification.Builder clone()| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
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()| Returns | |
|---|---|
| Type | Description |
WebhookNotification | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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.
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()
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.
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(WebhookNotification other)
public WebhookNotification.Builder mergeFrom(WebhookNotification other)| Parameter | |
|---|---|
| Name | Description |
other | WebhookNotification |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WebhookNotification.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public WebhookNotification.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WebhookNotification.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
setChannelToken(String value)
public WebhookNotification.Builder setChannelToken(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe channelToken to set. |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | This builder for chaining. |
setChannelTokenBytes(ByteString value)
public WebhookNotification.Builder setChannelTokenBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for channelToken to set. |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public WebhookNotification.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WebhookNotification.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final WebhookNotification.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | |
setUri(String value)
public WebhookNotification.Builder setUri(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe uri to set. |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | This builder for chaining. |
setUriBytes(ByteString value)
public WebhookNotification.Builder setUriBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for uri to set. |
| Returns | |
|---|---|
| Type | Description |
WebhookNotification.Builder | This builder for chaining. |