public final class ListPropertiesRequest extends GeneratedMessageV3 implements ListPropertiesRequestOrBuilder
Request message for ListProperties RPC.
Protobuf type google.analytics.admin.v1alpha.ListPropertiesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
SHOW_DELETED_FIELD_NUMBER
public static final int SHOW_DELETED_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListPropertiesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListPropertiesRequest.Builder newBuilder()
newBuilder(ListPropertiesRequest prototype)
public static ListPropertiesRequest.Builder newBuilder(ListPropertiesRequest prototype)
public static ListPropertiesRequest parseDelimitedFrom(InputStream input)
public static ListPropertiesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListPropertiesRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListPropertiesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListPropertiesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListPropertiesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListPropertiesRequest parseFrom(CodedInputStream input)
public static ListPropertiesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListPropertiesRequest parseFrom(InputStream input)
public static ListPropertiesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListPropertiesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListPropertiesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListPropertiesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListPropertiesRequest getDefaultInstanceForType()
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];
Returns |
Type |
Description |
String |
The filter.
|
getFilterBytes()
public 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 |
Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
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;
Returns |
Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
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;
Returns |
Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
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;
Returns |
Type |
Description |
ByteString |
The bytes for pageToken.
|
getParserForType()
public Parser<ListPropertiesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
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;
Returns |
Type |
Description |
boolean |
The showDeleted.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListPropertiesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListPropertiesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ListPropertiesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides