Reference documentation and code samples for the Google LongRunning Client class ListOperationsRequest.
The request message for Operations.ListOperations.
Generated from protobuf message google.longrunning.ListOperationsRequest
Namespace
Google \ LongRunningMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the operation's parent resource. |
↳ filter |
string
The standard list filter. |
↳ page_size |
int
The standard list page size. |
↳ page_token |
string
The standard list page token. |
↳ return_partial_success |
bool
When set to |
getName
The name of the operation's parent resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of the operation's parent resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
The standard list filter.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
The standard list filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The standard list page size.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The standard list page size.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The standard list page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The standard list page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReturnPartialSuccess
When set to true, operations that are reachable are returned as normal,
and those that are unreachable are returned in the
[ListOperationsResponse.unreachable] field.
This can only be true when reading across collections e.g. when parent
is set to "projects/example/locations/-".
This field is not by default supported and will result in an
UNIMPLEMENTED error if set unless explicitly documented otherwise in
service or product specific documentation.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReturnPartialSuccess
When set to true, operations that are reachable are returned as normal,
and those that are unreachable are returned in the
[ListOperationsResponse.unreachable] field.
This can only be true when reading across collections e.g. when parent
is set to "projects/example/locations/-".
This field is not by default supported and will result in an
UNIMPLEMENTED error if set unless explicitly documented otherwise in
service or product specific documentation.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
The name of the operation's parent resource. |
filter |
string
The standard list filter. |
| Returns | |
|---|---|
| Type | Description |
ListOperationsRequest |
|