public final class ListAttributesRequest extends GeneratedMessageV3 implements ListAttributesRequestOrBuilder
The ListAttributes method's
request.
Protobuf type google.cloud.apihub.v1.ListAttributesRequest
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 |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListAttributesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListAttributesRequest.Builder newBuilder()
newBuilder(ListAttributesRequest prototype)
public static ListAttributesRequest.Builder newBuilder(ListAttributesRequest prototype)
public static ListAttributesRequest parseDelimitedFrom(InputStream input)
public static ListAttributesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListAttributesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListAttributesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListAttributesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListAttributesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListAttributesRequest parseFrom(CodedInputStream input)
public static ListAttributesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListAttributesRequest parseFrom(InputStream input)
public static ListAttributesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListAttributesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListAttributesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListAttributesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListAttributesRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. An expression that filters the list of Attributes.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Attribute are eligible for filtering:
display_name - The display name of the Attribute. Allowed
comparison operators: =.definition_type - The definition type of the attribute. Allowed
comparison operators: =.scope - The scope of the attribute. Allowed comparison operators:
=.data_type - The type of the data of the attribute. Allowed
comparison operators: =.mandatory - Denotes whether the attribute is mandatory or not.
Allowed comparison operators: =.create_time - The time at which the Attribute was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
Expressions are combined with either AND logic operator or OR logical
operator but not both of them together i.e. only one of the AND or OR
operator can be used throughout the filter string and both the operators
cannot be used together. No other logical operators are
supported. At most three filter fields are allowed in the filter
string and if provided more than that then INVALID_ARGUMENT error is
returned by the API.
Here are a few examples:
display_name = production - - The display name of the attribute is
production.
(display_name = production) AND (create_time <
\"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") -
The display name of the attribute is production and the attribute was
created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00
UTC.display_name = production OR scope = api -
The attribute where the display name is production or the scope is
api.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Optional. An expression that filters the list of Attributes.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <, > or
=. Filters are not case sensitive.
The following fields in the Attribute are eligible for filtering:
display_name - The display name of the Attribute. Allowed
comparison operators: =.definition_type - The definition type of the attribute. Allowed
comparison operators: =.scope - The scope of the attribute. Allowed comparison operators:
=.data_type - The type of the data of the attribute. Allowed
comparison operators: =.mandatory - Denotes whether the attribute is mandatory or not.
Allowed comparison operators: =.create_time - The time at which the Attribute was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.
Expressions are combined with either AND logic operator or OR logical
operator but not both of them together i.e. only one of the AND or OR
operator can be used throughout the filter string and both the operators
cannot be used together. No other logical operators are
supported. At most three filter fields are allowed in the filter
string and if provided more than that then INVALID_ARGUMENT error is
returned by the API.
Here are a few examples:
display_name = production - - The display name of the attribute is
production.
(display_name = production) AND (create_time <
\"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") -
The display name of the attribute is production and the attribute was
created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00
UTC.display_name = production OR scope = api -
The attribute where the display name is production or the scope is
api.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
Optional. The maximum number of attribute resources to return. The service
may return fewer than this value. If unspecified, at most 50 attributes
will be returned. The maximum value is 1000; values above 1000 will be
coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
Optional. A page token, received from a previous ListAttributes call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAttributes must
match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. A page token, received from a previous ListAttributes call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListAttributes must
match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParent()
public String getParent()
Required. The parent resource for Attribute.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The parent resource for Attribute.
Format: projects/{project}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListAttributesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListAttributesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListAttributesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListAttributesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
