Package com.google.analytics.admin.v1alpha

Class ListPropertiesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessage.Builder<ListPropertiesRequest.Builder>

com.google.analytics.admin.v1alpha.ListPropertiesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListPropertiesRequest

public static final class ListPropertiesRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListPropertiesRequest.Builder>
implements ListPropertiesRequestOrBuilder

 Request message for ListProperties RPC.
 

Protobuf type google.analytics.admin.v1alpha.ListPropertiesRequest

Method Summary

Modifier and Type	Method	Description
ListPropertiesRequest	build()
ListPropertiesRequest	buildPartial()
ListPropertiesRequest.Builder	clear()
ListPropertiesRequest.Builder	clearFilter()	Required.
ListPropertiesRequest.Builder	clearPageSize()	Optional.
ListPropertiesRequest.Builder	clearPageToken()	Optional.
ListPropertiesRequest.Builder	clearShowDeleted()	Whether to include soft-deleted (ie: "trashed") Properties in the results.
ListPropertiesRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
ListPropertiesRequest.Builder	mergeFrom(ListPropertiesRequest other)
ListPropertiesRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListPropertiesRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListPropertiesRequest.Builder	setFilter(String value)	Required.
ListPropertiesRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value)	Required.
ListPropertiesRequest.Builder	setPageSize(int value)	Optional.
ListPropertiesRequest.Builder	setPageToken(String value)	Optional.
ListPropertiesRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value)	Optional.
ListPropertiesRequest.Builder	setShowDeleted(boolean value)	Whether to include soft-deleted (ie: "trashed") Properties in the results.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

clear

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

getDefaultInstanceForType

public ListPropertiesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListPropertiesRequest build()

Specified by:

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

Specified by:

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

buildPartial

public ListPropertiesRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

public ListPropertiesRequest.Builder mergeFrom(ListPropertiesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListPropertiesRequest.Builder>

mergeFrom

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

Throws:

IOException

getFilter

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

Specified by:

getFilter in interface ListPropertiesRequestOrBuilder

Returns:

The filter.

getFilterBytes

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

Specified by:

getFilterBytes in interface ListPropertiesRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListPropertiesRequest.Builder setFilter(String value)

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListPropertiesRequest.Builder clearFilter()

 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:

This builder for chaining.

setFilterBytes

public ListPropertiesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getPageSize

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

Specified by:

getPageSize in interface ListPropertiesRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListPropertiesRequest.Builder setPageSize(int value)

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

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListPropertiesRequest.Builder clearPageSize()

 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:

This builder for chaining.

getPageToken

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

Specified by:

getPageToken in interface ListPropertiesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

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

Specified by:

getPageTokenBytes in interface ListPropertiesRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListPropertiesRequest.Builder setPageToken(String value)

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

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListPropertiesRequest.Builder clearPageToken()

 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:

This builder for chaining.

setPageTokenBytes

public ListPropertiesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getShowDeleted

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

Specified by:

getShowDeleted in interface ListPropertiesRequestOrBuilder

Returns:

The showDeleted.

setShowDeleted

public ListPropertiesRequest.Builder setShowDeleted(boolean value)

 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;

Parameters:

value - The showDeleted to set.

Returns:

This builder for chaining.

clearShowDeleted

public ListPropertiesRequest.Builder clearShowDeleted()

 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:

This builder for chaining.