Class RecurringAudienceList.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder>
com.google.analytics.data.v1alpha.RecurringAudienceList.Builder
All Implemented Interfaces:
RecurringAudienceListOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RecurringAudienceList

public static final class RecurringAudienceList.Builder extends com.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder> implements RecurringAudienceListOrBuilder
 A recurring audience list produces new audience lists each day. Audience
 lists are users in an audience at the time of the list's creation. A
 recurring audience list ensures that you have audience list based on the most
 recent data available for use each day.
 
Protobuf type google.analytics.data.v1alpha.RecurringAudienceList
  • 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<RecurringAudienceList.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<RecurringAudienceList.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<RecurringAudienceList.Builder>
    • getDefaultInstanceForType

      public RecurringAudienceList getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public RecurringAudienceList build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public RecurringAudienceList buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public RecurringAudienceList.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<RecurringAudienceList.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<RecurringAudienceList.Builder>
    • mergeFrom

      public RecurringAudienceList.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<RecurringAudienceList.Builder>
      Throws:
      IOException
    • getName

      public String getName()
       Output only. Identifier. The recurring audience list resource name assigned
       during creation. This resource name identifies this
       `RecurringAudienceList`.
      
       Format:
       `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface RecurringAudienceListOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. The recurring audience list resource name assigned
       during creation. This resource name identifies this
       `RecurringAudienceList`.
      
       Format:
       `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface RecurringAudienceListOrBuilder
      Returns:
      The bytes for name.
    • setName

      public RecurringAudienceList.Builder setName(String value)
       Output only. Identifier. The recurring audience list resource name assigned
       during creation. This resource name identifies this
       `RecurringAudienceList`.
      
       Format:
       `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public RecurringAudienceList.Builder clearName()
       Output only. Identifier. The recurring audience list resource name assigned
       during creation. This resource name identifies this
       `RecurringAudienceList`.
      
       Format:
       `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setNameBytes

      public RecurringAudienceList.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Identifier. The recurring audience list resource name assigned
       during creation. This resource name identifies this
       `RecurringAudienceList`.
      
       Format:
       `properties/{property}/recurringAudienceLists/{recurring_audience_list}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • getAudience

      public String getAudience()
       Required. The audience resource name. This resource name identifies the
       audience being listed and is shared between the Analytics Data & Admin
       APIs.
      
       Format: `properties/{property}/audiences/{audience}`
       
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudience in interface RecurringAudienceListOrBuilder
      Returns:
      The audience.
    • getAudienceBytes

      public com.google.protobuf.ByteString getAudienceBytes()
       Required. The audience resource name. This resource name identifies the
       audience being listed and is shared between the Analytics Data & Admin
       APIs.
      
       Format: `properties/{property}/audiences/{audience}`
       
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAudienceBytes in interface RecurringAudienceListOrBuilder
      Returns:
      The bytes for audience.
    • setAudience

      public RecurringAudienceList.Builder setAudience(String value)
       Required. The audience resource name. This resource name identifies the
       audience being listed and is shared between the Analytics Data & Admin
       APIs.
      
       Format: `properties/{property}/audiences/{audience}`
       
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The audience to set.
      Returns:
      This builder for chaining.
    • clearAudience

      public RecurringAudienceList.Builder clearAudience()
       Required. The audience resource name. This resource name identifies the
       audience being listed and is shared between the Analytics Data & Admin
       APIs.
      
       Format: `properties/{property}/audiences/{audience}`
       
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • setAudienceBytes

      public RecurringAudienceList.Builder setAudienceBytes(com.google.protobuf.ByteString value)
       Required. The audience resource name. This resource name identifies the
       audience being listed and is shared between the Analytics Data & Admin
       APIs.
      
       Format: `properties/{property}/audiences/{audience}`
       
      string audience = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for audience to set.
      Returns:
      This builder for chaining.
    • getAudienceDisplayName

      public String getAudienceDisplayName()
       Output only. The descriptive display name for this audience. For example,
       "Purchasers".
       
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceDisplayName in interface RecurringAudienceListOrBuilder
      Returns:
      The audienceDisplayName.
    • getAudienceDisplayNameBytes

      public com.google.protobuf.ByteString getAudienceDisplayNameBytes()
       Output only. The descriptive display name for this audience. For example,
       "Purchasers".
       
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceDisplayNameBytes in interface RecurringAudienceListOrBuilder
      Returns:
      The bytes for audienceDisplayName.
    • setAudienceDisplayName

      public RecurringAudienceList.Builder setAudienceDisplayName(String value)
       Output only. The descriptive display name for this audience. For example,
       "Purchasers".
       
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The audienceDisplayName to set.
      Returns:
      This builder for chaining.
    • clearAudienceDisplayName

      public RecurringAudienceList.Builder clearAudienceDisplayName()
       Output only. The descriptive display name for this audience. For example,
       "Purchasers".
       
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setAudienceDisplayNameBytes

      public RecurringAudienceList.Builder setAudienceDisplayNameBytes(com.google.protobuf.ByteString value)
       Output only. The descriptive display name for this audience. For example,
       "Purchasers".
       
      string audience_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for audienceDisplayName to set.
      Returns:
      This builder for chaining.
    • getDimensionsList

      public List<AudienceDimension> getDimensionsList()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsList in interface RecurringAudienceListOrBuilder
    • getDimensionsCount

      public int getDimensionsCount()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsCount in interface RecurringAudienceListOrBuilder
    • getDimensions

      public AudienceDimension getDimensions(int index)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensions in interface RecurringAudienceListOrBuilder
    • setDimensions

      public RecurringAudienceList.Builder setDimensions(int index, AudienceDimension value)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • setDimensions

      public RecurringAudienceList.Builder setDimensions(int index, AudienceDimension.Builder builderForValue)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addDimensions

      public RecurringAudienceList.Builder addDimensions(AudienceDimension value)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addDimensions

      public RecurringAudienceList.Builder addDimensions(int index, AudienceDimension value)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addDimensions

      public RecurringAudienceList.Builder addDimensions(AudienceDimension.Builder builderForValue)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addDimensions

      public RecurringAudienceList.Builder addDimensions(int index, AudienceDimension.Builder builderForValue)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addAllDimensions

      public RecurringAudienceList.Builder addAllDimensions(Iterable<? extends AudienceDimension> values)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • clearDimensions

      public RecurringAudienceList.Builder clearDimensions()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • removeDimensions

      public RecurringAudienceList.Builder removeDimensions(int index)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • getDimensionsBuilder

      public AudienceDimension.Builder getDimensionsBuilder(int index)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • getDimensionsOrBuilder

      public AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsOrBuilder in interface RecurringAudienceListOrBuilder
    • getDimensionsOrBuilderList

      public List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDimensionsOrBuilderList in interface RecurringAudienceListOrBuilder
    • addDimensionsBuilder

      public AudienceDimension.Builder addDimensionsBuilder()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • addDimensionsBuilder

      public AudienceDimension.Builder addDimensionsBuilder(int index)
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • getDimensionsBuilderList

      public List<AudienceDimension.Builder> getDimensionsBuilderList()
       Required. The dimensions requested and displayed in the audience list
       response.
       
      repeated .google.analytics.data.v1alpha.AudienceDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
    • hasActiveDaysRemaining

      public boolean hasActiveDaysRemaining()
       Optional. The number of remaining days that a recurring audience export
       will produce an audience list instance. This counter decreases by one each
       day, and when it reaches zero, no new audience lists will be created.
      
       Recurring audience list request for Analytics 360 properties default to 180
       days and have a maximum of 365 days. Requests for standard Analytics
       properties default to 14 days and have a maximum of 30 days.
      
       The minimum value allowed during creation is 1. Requests above their
       respective maximum will be coerced to their maximum.
       
      optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasActiveDaysRemaining in interface RecurringAudienceListOrBuilder
      Returns:
      Whether the activeDaysRemaining field is set.
    • getActiveDaysRemaining

      public int getActiveDaysRemaining()
       Optional. The number of remaining days that a recurring audience export
       will produce an audience list instance. This counter decreases by one each
       day, and when it reaches zero, no new audience lists will be created.
      
       Recurring audience list request for Analytics 360 properties default to 180
       days and have a maximum of 365 days. Requests for standard Analytics
       properties default to 14 days and have a maximum of 30 days.
      
       The minimum value allowed during creation is 1. Requests above their
       respective maximum will be coerced to their maximum.
       
      optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActiveDaysRemaining in interface RecurringAudienceListOrBuilder
      Returns:
      The activeDaysRemaining.
    • setActiveDaysRemaining

      public RecurringAudienceList.Builder setActiveDaysRemaining(int value)
       Optional. The number of remaining days that a recurring audience export
       will produce an audience list instance. This counter decreases by one each
       day, and when it reaches zero, no new audience lists will be created.
      
       Recurring audience list request for Analytics 360 properties default to 180
       days and have a maximum of 365 days. Requests for standard Analytics
       properties default to 14 days and have a maximum of 30 days.
      
       The minimum value allowed during creation is 1. Requests above their
       respective maximum will be coerced to their maximum.
       
      optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The activeDaysRemaining to set.
      Returns:
      This builder for chaining.
    • clearActiveDaysRemaining

      public RecurringAudienceList.Builder clearActiveDaysRemaining()
       Optional. The number of remaining days that a recurring audience export
       will produce an audience list instance. This counter decreases by one each
       day, and when it reaches zero, no new audience lists will be created.
      
       Recurring audience list request for Analytics 360 properties default to 180
       days and have a maximum of 365 days. Requests for standard Analytics
       properties default to 14 days and have a maximum of 30 days.
      
       The minimum value allowed during creation is 1. Requests above their
       respective maximum will be coerced to their maximum.
       
      optional int32 active_days_remaining = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getAudienceListsList

      public com.google.protobuf.ProtocolStringList getAudienceListsList()
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceListsList in interface RecurringAudienceListOrBuilder
      Returns:
      A list containing the audienceLists.
    • getAudienceListsCount

      public int getAudienceListsCount()
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceListsCount in interface RecurringAudienceListOrBuilder
      Returns:
      The count of audienceLists.
    • getAudienceLists

      public String getAudienceLists(int index)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceLists in interface RecurringAudienceListOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The audienceLists at the given index.
    • getAudienceListsBytes

      public com.google.protobuf.ByteString getAudienceListsBytes(int index)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAudienceListsBytes in interface RecurringAudienceListOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the audienceLists at the given index.
    • setAudienceLists

      public RecurringAudienceList.Builder setAudienceLists(int index, String value)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index to set the value at.
      value - The audienceLists to set.
      Returns:
      This builder for chaining.
    • addAudienceLists

      public RecurringAudienceList.Builder addAudienceLists(String value)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The audienceLists to add.
      Returns:
      This builder for chaining.
    • addAllAudienceLists

      public RecurringAudienceList.Builder addAllAudienceLists(Iterable<String> values)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      values - The audienceLists to add.
      Returns:
      This builder for chaining.
    • clearAudienceLists

      public RecurringAudienceList.Builder clearAudienceLists()
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • addAudienceListsBytes

      public RecurringAudienceList.Builder addAudienceListsBytes(com.google.protobuf.ByteString value)
       Output only. Audience list resource names for audience list instances
       created for this recurring audience list. One audience list is created for
       each day, and the audience list will be listed here.
      
       This list is ordered with the most recently created audience list first.
       
      repeated string audience_lists = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes of the audienceLists to add.
      Returns:
      This builder for chaining.
    • hasWebhookNotification

      public boolean hasWebhookNotification()
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWebhookNotification in interface RecurringAudienceListOrBuilder
      Returns:
      Whether the webhookNotification field is set.
    • getWebhookNotification

      public WebhookNotification getWebhookNotification()
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookNotification in interface RecurringAudienceListOrBuilder
      Returns:
      The webhookNotification.
    • setWebhookNotification

      public RecurringAudienceList.Builder setWebhookNotification(WebhookNotification value)
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
    • setWebhookNotification

      public RecurringAudienceList.Builder setWebhookNotification(WebhookNotification.Builder builderForValue)
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
    • mergeWebhookNotification

      public RecurringAudienceList.Builder mergeWebhookNotification(WebhookNotification value)
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
    • clearWebhookNotification

      public RecurringAudienceList.Builder clearWebhookNotification()
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getWebhookNotificationBuilder

      public WebhookNotification.Builder getWebhookNotificationBuilder()
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
    • getWebhookNotificationOrBuilder

      public WebhookNotificationOrBuilder getWebhookNotificationOrBuilder()
       Optional. Configures webhook notifications to be sent from the Google
       Analytics Data API to your webhook server. Use of webhooks is optional. If
       unused, you'll need to poll this API to determine when a recurring audience
       list creates new audience lists. Webhooks allow a notification to be sent
       to your servers & avoid the need for polling.
      
       Two POST requests will be sent each time a recurring audience list creates
       an audience list. This happens once per day until a recurring audience list
       reaches 0 active days remaining. The first request will be sent showing a
       newly created audience list in its CREATING state. The second request will
       be sent after the audience list completes creation (either the ACTIVE or
       FAILED state).
       
      optional .google.analytics.data.v1alpha.WebhookNotification webhook_notification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookNotificationOrBuilder in interface RecurringAudienceListOrBuilder