com.google.analytics.data.v1alpha

Class WebhookNotification.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

com.google.analytics.data.v1alpha.WebhookNotification.Builder

All Implemented Interfaces:

WebhookNotificationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

WebhookNotification

public static final class WebhookNotification.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>
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

Method Summary

Modifier and Type	Method and Description
WebhookNotification.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
WebhookNotification	build()
WebhookNotification	buildPartial()
WebhookNotification.Builder	clear()
WebhookNotification.Builder	clearChannelToken() Optional.
WebhookNotification.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
WebhookNotification.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
WebhookNotification.Builder	clearUri() Optional.
WebhookNotification.Builder	clone()
String	getChannelToken() Optional.
com.google.protobuf.ByteString	getChannelTokenBytes() Optional.
WebhookNotification	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getUri() Optional.
com.google.protobuf.ByteString	getUriBytes() Optional.
boolean	hasChannelToken() Optional.
boolean	hasUri() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
WebhookNotification.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
WebhookNotification.Builder	mergeFrom(com.google.protobuf.Message other)
WebhookNotification.Builder	mergeFrom(WebhookNotification other)
WebhookNotification.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
WebhookNotification.Builder	setChannelToken(String value) Optional.
WebhookNotification.Builder	setChannelTokenBytes(com.google.protobuf.ByteString value) Optional.
WebhookNotification.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
WebhookNotification.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
WebhookNotification.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
WebhookNotification.Builder	setUri(String value) Optional.
WebhookNotification.Builder	setUriBytes(com.google.protobuf.ByteString value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<WebhookNotification.Builder>

clear

public WebhookNotification.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

getDefaultInstanceForType

public WebhookNotification getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public WebhookNotification build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public WebhookNotification buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public WebhookNotification.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

setField

public WebhookNotification.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

clearField

public WebhookNotification.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

clearOneof

public WebhookNotification.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

setRepeatedField

public WebhookNotification.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

addRepeatedField

public WebhookNotification.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

mergeFrom

public WebhookNotification.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WebhookNotification.Builder>

mergeFrom

public WebhookNotification.Builder mergeFrom(WebhookNotification other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

mergeFrom

public WebhookNotification.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WebhookNotification.Builder>

Throws:

IOException

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.

setUri

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](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];

Parameters:

value - The uri to set.

Returns:

This builder for chaining.

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](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];

Returns:

This builder for chaining.

setUriBytes

public WebhookNotification.Builder setUriBytes(com.google.protobuf.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](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];

Parameters:

value - The bytes for uri to set.

Returns:

This builder for chaining.

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.

setChannelToken

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];

Parameters:

value - The channelToken to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setChannelTokenBytes

public WebhookNotification.Builder setChannelTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for channelToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final WebhookNotification.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>

mergeUnknownFields

public final WebhookNotification.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WebhookNotification.Builder>