Package com.google.analytics.admin.v1alpha

Interface ListPropertiesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListPropertiesRequest, ListPropertiesRequest.Builder
@Generated public interface ListPropertiesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Required.
    com.google.protobuf.ByteString
    getFilterBytes()
    Required.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    boolean
    getShowDeleted()
    Whether to include soft-deleted (ie: "trashed") Properties in the results.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFilter

      String getFilter()
       Required. An expression for filtering the results of the request.
 Fields eligible for filtering are:
 `parent:`(The resource name of the parent account/property) or
 `ancestor:`(The resource name of the parent account) or
 `firebase_project:`(The id or number of the linked firebase project).
 Some examples of filters:

 ```
 | Filter                      | Description                               |
 |-----------------------------|-------------------------------------------|
 | parent:accounts/123         | The account with account id: 123.       |
 | parent:properties/123       | The property with property id: 123.       |
 | ancestor:accounts/123       | The account with account id: 123.         |
 | firebase_project:project-id | The firebase project with id: project-id. |
 | firebase_project:123        | The firebase project with number: 123.    |
 ```
      string filter = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Required. An expression for filtering the results of the request.
 Fields eligible for filtering are:
 `parent:`(The resource name of the parent account/property) or
 `ancestor:`(The resource name of the parent account) or
 `firebase_project:`(The id or number of the linked firebase project).
 Some examples of filters:

 ```
 | Filter                      | Description                               |
 |-----------------------------|-------------------------------------------|
 | parent:accounts/123         | The account with account id: 123.       |
 | parent:properties/123       | The property with property id: 123.       |
 | ancestor:accounts/123       | The account with account id: 123.         |
 | firebase_project:project-id | The firebase project with id: project-id. |
 | firebase_project:123        | The firebase project with number: 123.    |
 ```
      string filter = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       Optional. The maximum number of resources to return. The service may return
 fewer than this value, even if there are additional pages.
 If unspecified, at most 50 resources will be returned.
 The maximum value is 200; (higher values will be coerced to the maximum)
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. A page token, received from a previous `ListProperties` call.
 Provide this to retrieve the subsequent page.
 When paginating, all other parameters provided to `ListProperties` must
 match the call that provided the page token.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token, received from a previous `ListProperties` call.
 Provide this to retrieve the subsequent page.
 When paginating, all other parameters provided to `ListProperties` must
 match the call that provided the page token.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getShowDeleted

      boolean getShowDeleted()
       Whether to include soft-deleted (ie: "trashed") Properties in the
 results. Properties can be inspected to determine whether they are deleted
 or not.
      bool show_deleted = 4;
      Returns:
      The showDeleted.