The Cloud Filestore API is used for creating and managing cloud file servers.
Lists information about the supported locations for this service.
Name | Data Type | Description |
---|---|---|
name
|
string |
The resource that owns the locations collection, if applicable. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListLocationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
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.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation's parent resource. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The standard list page token. |
pageSize
|
integer |
The standard list page size. |
filter
|
string |
The standard list filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListOperationsResponse | |||||||||||||||||||||||||||||||||
Properties
|
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the operation resource to be cancelled. |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
CancelOperationRequest | |||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
|
Empty | |||||
|
Deletes an instance.
Name | Data Type | Description |
---|---|---|
name
|
string |
The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Gets the details of a specific instance.
Name | Data Type | Description |
---|---|---|
name
|
string |
The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Instance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates the settings of a specific instance.
Name | Data Type | Description |
---|---|---|
name
|
string |
Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
Name | Data Type | Description |
---|---|---|
updateMask
|
string |
Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: "description" "file_shares" "labels" |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Instance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
Lists all instances in a project for either a specified location or for all locations.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value. |
Name | Data Type | Description |
---|---|---|
pageToken
|
string |
The next_page_token value to use if there are additional results to retrieve for this list request. |
pageSize
|
integer |
The maximum number of items to return. |
orderBy
|
string |
Sort results. Supported values are "name", "name desc" or "" (unsorted). |
filter
|
string |
List filter. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ListInstancesResponse | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates an instance.
Name | Data Type | Description |
---|---|---|
parent
|
string |
The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. |
Name | Data Type | Description |
---|---|---|
instanceId
|
string |
The name of the instance to create. The name must be unique for the specified project and location. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Instance | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Operation | ||||||||||||||||||||||||||||||||||||
Properties
|
The request message for Operations.CancelOperation.
Name | Data Type | Description |
---|---|---|
CancelOperationRequest
|
object |
The request message for Operations.CancelOperation. |
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty
is empty JSON object {}
.
Name | Data Type | Description |
---|---|---|
Empty
|
object |
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
The JSON representation for |
File share configuration for the instance.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the file share (must be 16 characters or less). |
capacityGb
|
string |
File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. |
Instance represents the interface for SLM services to actuate the state of control plane resources.
Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql:
Instance:
{
"name":
"projects/snapchat/locations/us-east1/instances/prod-instance",
"create_time": {
"seconds": 1526406431,
},
"labels": {
"env": "prod",
"foo": "bar"
},
"state": READY,
"software_versions": {
"software_update": "cloud-sql-09-28-2018",
},
"maintenance_policy_names": {
"UpdatePolicy":
"projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy",
}
"rollout_metadata": {
"projects/cloud-sql/locations/global/rolloutTypes/software_update": {
"release":
"projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018",
"rollout":
"projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary",
},
"projects/cloud-sql/locations/global/rolloutTypes/instance_restart": {
"release":
"projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair",
"rollout":
"projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent",
}
}
"tenant_project_id": "cloud-sql-test-tenant",
"producer_metadata": {
"cloud-sql-tier": "basic",
"cloud-sql-instance-size": "1G",
},
"provisioned_resources": [
{
"resource-type": "compute-instance",
"resource-url":
"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1",
}
],
"maintenance_schedules": {
"csa_rollout": {
"start_time": {
"seconds": 1526406431,
},
"end_time": {
"seconds": 1535406431,
},
},
"ncsa_rollout": {
"start_time": {
"seconds": 1526406431,
},
"end_time": {
"seconds": 1535406431,
},
}
},
"consumer_defined_name": "my-sql-instance1",
}
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
updateTime
|
string |
Output only. Timestamp when the resource was last modified. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenantProjectId
|
string |
Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state
|
string Allowed values: - STATE_UNSPECIFIED - CREATING - READY - UPDATING - REPAIRING - DELETING |
Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
softwareVersions
|
object |
Software versions that are used to deploy this instance. This can be mutated by rollout services. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sloMetadata
|
GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata |
Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rolloutMetadata
|
object |
The map between RolloutType and the corresponding RolloutMetadata. This is only mutated by rollout service. For actuation implementation, this information is pass-through for Rollout management. Producer shall not modify by itself. For update of a single entry in this map, the update field mask shall follow this sementics: go/advanced-field-masks |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provisionedResources
|
array [GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource] |
Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
producerMetadata
|
object |
Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
Unique name of the resource. It uses the form:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maintenanceSchedules
|
object |
The MaintenanceSchedule contains the scheduling information of published maintenance schedule. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maintenancePolicyNames
|
object |
The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
labels
|
object |
Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createTime
|
string |
Output only. Timestamp when the resource was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
consumerDefinedName
|
string |
consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances. |
Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule
Name | Data Type | Description |
---|---|---|
startTime
|
string |
The scheduled start time for the maintenance. |
rolloutManagementPolicy
|
string |
The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy. |
endTime
|
string |
The scheduled end time for the maintenance. |
canReschedule
|
boolean |
Can this scheduled update be rescheduled? By default, it's true and API needs to do explicitly check whether it's set, if it's set as false explicitly, it's false |
Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nodeId
|
string |
The id of the node. This should be equal to SaasInstanceNode.node_id. |
||||||||||||||||
location
|
string |
The location of the node, if different from instance location. |
||||||||||||||||
exclusions
|
array [GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion] |
By default node is eligible if instance is eligible. But individual node might be excluded from SLO by adding entry here. For semantic see SloMetadata.exclusions. If both instance and node level exclusions are present for time period, the node level's reason will be reported by Eligibility Exporter. |
||||||||||||||||
Properties
|
NotificationMetadata is the notification state for an instance.
Name | Data Type | Description |
---|---|---|
targetRelease
|
string |
The target release to be applied to the instance. |
scheduledStartTime
|
string |
The scheduled start time for the maintenance window during which update can be performed on the instance. |
scheduledEndTime
|
string |
The scheduled end time for the maintenance window during which update can be performed on the instance. |
rescheduled
|
boolean |
Whether the instance update has been rescheduled. |
Describes provisioned dataplane resources.
Name | Data Type | Description |
---|---|---|
resourceUrl
|
string |
URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". |
resourceType
|
string |
Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. |
RolloutMetadata for an actuation instance. It maps to a single RolloutType.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rolloutName
|
string |
The last rollout that has been applied to the instance. |
||||||||||||||||
releaseName
|
string |
The last Release that has been applied to the instance. |
||||||||||||||||
notification
|
GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata |
Instance level notification metadata. |
||||||||||||||||
Properties
|
SloExclusion represents an excusion in SLI calculation applies to all SLOs.
Name | Data Type | Description |
---|---|---|
sliName
|
string |
Name of an SLI that this exclusion applies to. Can be left empty, signaling that the instance should be excluded from all SLIs defined in the service SLO configuration. |
reason
|
string |
Human-readable reason for the exclusion. This should be a static string (e.g. "Disruptive update in progress") and should not contain dynamically generated data (e.g. instance name). Can be left empty. |
exclusionStartTime
|
string |
Start time of the exclusion. No alignment (e.g. to a full minute) needed. |
exclusionDuration
|
string |
Exclusion duration. No restrictions on the possible values. When an ongoing operation is taking longer than initially expected, an existing entry in the exclusion list can be updated by extending the duration. This is supported by the subsystem exporting eligibility data as long as such extension is committed at least 10 minutes before the original exclusion expiration - otherwise it is possible that there will be "gaps" in the exclusion application in the exported timeseries. |
SloMetadata contains resources required for proper SLO classification of the instance.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tier
|
string |
Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. |
||||||||||||||||||||||||||||||||
nodes
|
array [GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata] |
Optional: list of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
exclusions
|
array [GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion] |
List of SLO exclusion windows. When multiple entries in the list match (matching the exclusion time-window against current time point) the exclusion reason used in the first matching entry will be published. It is not needed to include expired exclusion in this list, as only the currently applicable exclusions are taken into account by the eligibility exporting subsystem (the historical state of exclusions will be reflected in the historically produced timeseries regardless of the current state). This field can be used to mark the instance as temporary ineligible for the purpose of SLO calculation. For permanent instance SLO exclusion, a dedicated tier name can be used that does not have targets specified in the service SLO configuration. |
||||||||||||||||||||||||||||||||
Properties
|
A Cloud Filestore instance.
Name | Data Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tier
|
string Allowed values: - TIER_UNSPECIFIED - STANDARD - PREMIUM |
The service tier of the instance. |
||||||||||||||||
statusMessage
|
string |
Output only. Additional information about the instance state, if available. |
||||||||||||||||
state
|
string Allowed values: - STATE_UNSPECIFIED - CREATING - READY - REPAIRING - DELETING - ERROR |
Output only. The instance state. |
||||||||||||||||
networks
|
array [NetworkConfig] |
VPC networks to which the instance is connected. For this version, only a single network is supported. |
||||||||||||||||
Properties
|
||||||||||||||||||
name
|
string |
Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. |
||||||||||||||||
labels
|
object |
Resource labels to represent user provided metadata. |
||||||||||||||||
fileShares
|
array [FileShareConfig] |
File system shares on the instance. For this version, only a single file share is supported. |
||||||||||||||||
Properties
|
||||||||||||||||||
etag
|
string |
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. |
||||||||||||||||
description
|
string |
Optional. A description of the instance (2048 characters or less). |
||||||||||||||||
createTime
|
string |
Output only. The time when the instance was created. |
ListInstancesResponse is the result of ListInstancesRequest.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unreachable
|
array [string] |
Locations that could not be reached. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instances
|
array [Instance] |
A list of instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The response message for Locations.ListLocations.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextPageToken
|
string |
The standard List next-page token. |
|||||||||||||||||||
locations
|
array [Location] |
A list of locations that matches the specified filter in the request. |
|||||||||||||||||||
Properties
|
The response message for Operations.ListOperations.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operations
|
array [Operation] |
A list of operations that matches the specified filter in the request. |
|||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||
nextPageToken
|
string |
The standard List next-page token. |
A resource that represents Google Cloud Platform location.
Name | Data Type | Description |
---|---|---|
name
|
string |
Resource name for the location, which may vary between implementations.
For example: |
metadata
|
object |
Service-specific metadata. For example the available capacity at the given location. |
locationId
|
string |
The canonical id for this location. For example: |
labels
|
object |
Cross-service attributes for the location. For example
|
displayName
|
string |
The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
Network configuration for the instance.
Name | Data Type | Description |
---|---|---|
reservedIpRange
|
string |
A /29 CIDR block in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. |
network
|
string |
The name of the Google Compute Engine VPC network to which the instance is connected. |
modes
|
array [string] Allowed values: - ADDRESS_MODE_UNSPECIFIED - MODE_IPV4 |
Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. |
ipAddresses
|
array [string] |
Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}. |
This resource represents a long-running operation that is the result of a network API call.
Name | Data Type | Description | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response
|
object |
The normal response of the operation in case of success. If the original
method returns no data on success, such as |
|||||||||||||
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
|
|||||||||||||
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. |
|||||||||||||
error
|
Status |
The error result of the operation in case of failure or cancellation. |
|||||||||||||
Properties
|
|||||||||||||||
done
|
boolean |
If the value is |
Represents the metadata of the long-running operation.
Name | Data Type | Description |
---|---|---|
verb
|
string |
[Output only] Name of the verb executed by the operation. |
target
|
string |
[Output only] Server-defined resource path for the target of the operation. |
statusDetail
|
string |
[Output only] Human-readable status of the operation, if any. |
endTime
|
string |
[Output only] The time the operation finished running. |
createTime
|
string |
[Output only] The time the operation was created. |
cancelRequested
|
boolean |
[Output only] Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have Operation.error value with a google.rpc.Status.code of 1,
corresponding to |
apiVersion
|
string |
[Output only] API version used to start the operation. |
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. 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.
Name | Data Type | Description |
---|---|---|
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. |
details
|
array [object] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |
code
|
integer |
The status code, which should be an enum value of google.rpc.Code. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 accessCode authentication
Flow:authorizationCode
https://accounts.google.com/o/oauth2/auth
https://accounts.google.com/o/oauth2/token
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform services
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Oauth 2.0 implicit authentication
Flow:implicit
https://accounts.google.com/o/oauth2/auth
https://www.googleapis.com/auth/cloud-platform
: View and manage your data across Google Cloud Platform servicesName | Google |
External URL | https://google.com |
OAS (OpenAPI Specification) | v3.0.0 |