operations
Creates, updates, deletes, gets or lists an operations
resource.
Overview
Name | operations |
Type | Resource |
Id | firebase.hosting.operations |
Fields
The following fields are returned by SELECT
queries:
- list
Successful response
Name | Datatype | Description |
---|---|---|
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} . |
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. |
error | object | The error result of the operation in case of failure or cancellation. (id: Status) |
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. |
response | object | The normal, successful response of the operation. 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 . |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | filter , pageSize , pageToken | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED . | |
delete | delete | projectsId , sitesId , customDomainsId , operationsId | DeleteOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources. | |
cancel | exec | projectsId , sitesId , customDomainsId , operationsId | CancelOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
customDomainsId | string | |
operationsId | string | |
projectsId | string | |
sitesId | string | |
filter | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT
examples
- list
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
SELECT
name,
done,
error,
metadata,
response
FROM firebase.hosting.operations
WHERE filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
DELETE
examples
- delete
DeleteOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources.
DELETE FROM firebase.hosting.operations
WHERE projectsId = '{{ projectsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND customDomainsId = '{{ customDomainsId }}' --required
AND operationsId = '{{ operationsId }}' --required;
Lifecycle Methods
- cancel
CancelOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources.
EXEC firebase.hosting.operations.cancel
@projectsId='{{ projectsId }}' --required,
@sitesId='{{ sitesId }}' --required,
@customDomainsId='{{ customDomainsId }}' --required,
@operationsId='{{ operationsId }}' --required;