Package com.google.analytics.data.v1alpha

Class QueryAudienceListRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<QueryAudienceListRequest.Builder>
com.google.analytics.data.v1alpha.QueryAudienceListRequest.Builder
All Implemented Interfaces:
QueryAudienceListRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
QueryAudienceListRequest
public static final class QueryAudienceListRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<QueryAudienceListRequest.Builder> implements QueryAudienceListRequestOrBuilder
 A request to list users in an audience list.
Protobuf type google.analytics.data.v1alpha.QueryAudienceListRequest

  • 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<QueryAudienceListRequest.Builder>

    • clear

      public QueryAudienceListRequest.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<QueryAudienceListRequest.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<QueryAudienceListRequest.Builder>

    • getDefaultInstanceForType

      public QueryAudienceListRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public QueryAudienceListRequest.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<QueryAudienceListRequest.Builder>

    • mergeFrom

      public QueryAudienceListRequest.Builder mergeFrom(QueryAudienceListRequest other)

    • isInitialized

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

    • mergeFrom

      public QueryAudienceListRequest.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<QueryAudienceListRequest.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Required. The name of the audience list to retrieve users from.
 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface QueryAudienceListRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the audience list to retrieve users from.
 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface QueryAudienceListRequestOrBuilder
      Returns:
      The bytes for name.

    • setName

      public QueryAudienceListRequest.Builder setName(String value)
       Required. The name of the audience list to retrieve users from.
 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public QueryAudienceListRequest.Builder clearName()
       Required. The name of the audience list to retrieve users from.
 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setNameBytes

      public QueryAudienceListRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The name of the audience list to retrieve users from.
 Format: `properties/{property}/audienceLists/{audience_list}`
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getOffset

      public long getOffset()
       Optional. The row count of the start row. The first row is counted as row
 0.

 When paging, the first request does not specify offset; or equivalently,
 sets offset to 0; the first request returns the first `limit` of rows. The
 second request sets offset to the `limit` of the first request; the second
 request returns the second `limit` of rows.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOffset in interface QueryAudienceListRequestOrBuilder
      Returns:
      The offset.

    • setOffset

      public QueryAudienceListRequest.Builder setOffset(long value)
       Optional. The row count of the start row. The first row is counted as row
 0.

 When paging, the first request does not specify offset; or equivalently,
 sets offset to 0; the first request returns the first `limit` of rows. The
 second request sets offset to the `limit` of the first request; the second
 request returns the second `limit` of rows.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The offset to set.
      Returns:
      This builder for chaining.

    • clearOffset

      public QueryAudienceListRequest.Builder clearOffset()
       Optional. The row count of the start row. The first row is counted as row
 0.

 When paging, the first request does not specify offset; or equivalently,
 sets offset to 0; the first request returns the first `limit` of rows. The
 second request sets offset to the `limit` of the first request; the second
 request returns the second `limit` of rows.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 offset = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getLimit

      public long getLimit()
       Optional. The number of rows to return. If unspecified, 10,000 rows are
 returned. The API returns a maximum of 250,000 rows per request, no matter
 how many you ask for. `limit` must be positive.

 The API can also return fewer rows than the requested `limit`, if there
 aren't as many dimension values as the `limit`.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLimit in interface QueryAudienceListRequestOrBuilder
      Returns:
      The limit.

    • setLimit

      public QueryAudienceListRequest.Builder setLimit(long value)
       Optional. The number of rows to return. If unspecified, 10,000 rows are
 returned. The API returns a maximum of 250,000 rows per request, no matter
 how many you ask for. `limit` must be positive.

 The API can also return fewer rows than the requested `limit`, if there
 aren't as many dimension values as the `limit`.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The limit to set.
      Returns:
      This builder for chaining.

    • clearLimit

      public QueryAudienceListRequest.Builder clearLimit()
       Optional. The number of rows to return. If unspecified, 10,000 rows are
 returned. The API returns a maximum of 250,000 rows per request, no matter
 how many you ask for. `limit` must be positive.

 The API can also return fewer rows than the requested `limit`, if there
 aren't as many dimension values as the `limit`.

 To learn more about this pagination parameter, see
 [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      int64 limit = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.