public static final class ListInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilderRequest for ListInstances.
Protobuf type google.cloud.redis.v1.ListInstancesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancesRequest.BuilderImplements
ListInstancesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
build()
public ListInstancesRequest build()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest | |
buildPartial()
public ListInstancesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest | |
clear()
public ListInstancesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
clearPageSize()
public ListInstancesRequest.Builder clearPageSize()The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
next_page_token
to determine if there are more instances left to be queried.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
clearPageToken()
public ListInstancesRequest.Builder clearPageToken() The next_page_token value returned from a previous
ListInstances request, if
any.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
clearParent()
public ListInstancesRequest.Builder clearParent() Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
clone()
public ListInstancesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getPageSize()
public int getPageSize()The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
next_page_token
to determine if there are more instances left to be queried.
int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken() The next_page_token value returned from a previous
ListInstances request, if
any.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() The next_page_token value returned from a previous
ListInstances request, if
any.
string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent() Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ListInstancesRequest other)
public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListInstancesRequest |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListInstancesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
setPageSize(int value)
public ListInstancesRequest.Builder setPageSize(int value)The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size value, the response may include a partial list
and a caller should only rely on response's
next_page_token
to determine if there are more instances left to be queried.
int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListInstancesRequest.Builder setPageToken(String value) The next_page_token value returned from a previous
ListInstances request, if
any.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListInstancesRequest.Builder setPageTokenBytes(ByteString value) The next_page_token value returned from a previous
ListInstances request, if
any.
string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
setParent(String value)
public ListInstancesRequest.Builder setParent(String value) Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListInstancesRequest.Builder setParentBytes(ByteString value) Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id refers to a GCP region.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest.Builder | |