Package 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.GeneratedMessage.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.GeneratedMessage.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 Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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.