List
|
|||||
|
|
||||
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/{name=users/}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your applications deployed on Google App Engine
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
appsId Required |
STRING |
Part of |
pageToken |
STRING |
The standard list page token |
pageSize |
INTEGER |
The standard list page size |
filter |
STRING |
The standard list filter |
= Parameter name
= Format
|
appsId STRING Required Part of |
|
pageToken STRING The standard list page token |
|
pageSize INTEGER The standard list page size |
|
filter STRING The standard list filter |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
operations[] |
OBJECT |
This resource represents a long-running operation that is the result of a network API call |
operations[].error |
OBJECT |
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
operations[].error.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
operations[].error.message |
STRING |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |
operations[].error.details[] |
OBJECT |
|
operations[].error.details[].customKey.value |
ANY |
|
operations[].metadata |
OBJECT |
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
operations[].metadata.customKey.value |
ANY |
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
operations[].done |
BOOLEAN |
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available |
operations[].response |
OBJECT |
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
operations[].response.customKey.value |
ANY |
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
operations[].name |
STRING |
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id} |
nextPageToken |
STRING |
The standard List next-page token |
= Parameter name
= Format
|
operations[] OBJECT This resource represents a long-running operation that is the result of a network API call |
|
operations[].error OBJECT The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
|
operations[].error.code INTEGER The status code, which should be an enum value of google.rpc.Code |
|
operations[].error.message STRING A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |
|
operations[].error.details[] OBJECT |
|
operations[].error.details[].customKey.value ANY |
|
operations[].metadata OBJECT Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
|
operations[].metadata.customKey.value ANY Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any |
|
operations[].done BOOLEAN If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available |
|
operations[].response OBJECT The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
|
operations[].response.customKey.value ANY The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse |
|
operations[].name STRING The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id} |
|
nextPageToken STRING The standard List next-page token |