openapi-directory/api/googleapis.com/file.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://file.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"The Cloud Filestore API is used for creating and managing cloud file servers.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Cloud Filestore API","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"format":"google","url":"https://file.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"file"},"externalDocs":{"url":"https://cloud.google.com/filestore/"},"tags":[{"name":"projects"}],"paths":{"/v1/{name}":{"delete":{"description":"Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.","operationId":"file.projects.locations.operations.delete","parameters":[{"description":"The name of the operation resource to be deleted.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"If set to true, all snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)","in":"query","name":"force","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"file.projects.locations.operations.get","parameters":[{"description":"The name of the operation resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates the settings of a specific snapshot.","operationId":"file.projects.locations.instances.snapshots.patch","parameters":[{"description":"Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Required. Mask of fields to update. At least one path must be supplied in this field.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}/locations":{"get":{"description":"Lists information about the supported locations for this service.","operationId":"file.projects.locations.list","parameters":[{"description":"The resource that owns the locations collection, if applicable.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).","in":"query","name":"filter","schema":{"type":"string"}},{"description":"If true, the returned list will include locations which are not yet revealed.","in":"query","name":"includeUnrevealedLocations","schema":{"type":"boolean"}},{"description":"The maximum number of results to return. If not set, the service selects a default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}/operations":{"get":{"description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.","operationId":"file.projects.locations.operations.list","parameters":[{"description":"The name of the operation's parent resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"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`.","operationId":"file.projects.locations.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOperationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:restore":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).","operationId":"file.projects.locations.instances.restore","parameters":[{"description":"Required. The resource name of the instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreInstanceRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:revert":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Revert an existing instance's file system to a specified snapshot.","operationId":"file.projects.locations.instances.revert","parameters":[{"description":"Required. `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The resource name of the instance, in the format","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevertInstanceRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/backups":{"get":{"description":"Lists all backups in a project for either a specified location or for all locations.","operationId":"file.projects.locations.backups.list","parameters":[{"description":"Required. The project and location for which to retrieve backup information, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**. To retrieve backup information for all locations, use \"-\" for the `{location}` value.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"List filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The next_page_token value to use if there are additional results to retrieve for this list request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackupsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a backup.","operationId":"file.projects.locations.backups.create","parameters":[{"description":"Required. The backup's project and location, in the format `projects/{project_number}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.","in":"query","name":"backupId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Backup"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/instances":{"get":{"description":"Lists all instances in a project for either a specified location or for all locations.","operationId":"file.projects.locations.instances.list","parameters":[{"description":"Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example **us-west1-b**. To retrieve instance information for all locations, use \"-\" for the `{location}` value.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"List filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The next_page_token value to use if there are additional results to retrieve for this list request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInstancesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).","operationId":"file.projects.locations.instances.create","parameters":[{"description":"Required. The instance's project and location, in the format `projects/{project_id}/locations/{location}`. In Filestore, locations map to Google Cloud zones, for example **us-west1-b**.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The name of the instance to create. The name must be unique for the specified project and location.","in":"query","name":"instanceId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instance"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/snapshots":{"get":{"description":"Lists all snapshots in a project for either a specified location or for all locations.","operationId":"file.projects.locations.instances.snapshots.list","parameters":[{"description":"Required. The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"List filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"The maximum number of items to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The next_page_token value to use if there are additional results to retrieve for this list request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSnapshotsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a snapshot.","operationId":"file.projects.locations.instances.snapshots.create","parameters":[{"description":"Required. The Filestore Instance to create the snapshots of, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.","in":"query","name":"snapshotId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshot"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"Backup":{"description":"A Filestore backup.","properties":{"capacityGb":{"description":"Output only. Capacity of the source file share when the backup was created.","format":"int64","readOnly":true,"type":"string"},"createTime":{"description":"Output only. The time when the backup was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.","type":"string"},"downloadBytes":{"description":"Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.","format":"int64","readOnly":true,"type":"string"},"kmsKey":{"description":"Immutable. KMS key name used for data encryption.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Resource labels to represent user provided metadata.","type":"object"},"name":{"description":"Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.","readOnly":true,"type":"string"},"satisfiesPzi":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"satisfiesPzs":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"sourceFileShare":{"description":"Name of the file share in the source Filestore instance that the backup is created from.","type":"string"},"sourceInstance":{"description":"The resource name of the source Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup.","type":"string"},"sourceInstanceTier":{"description":"Output only. The service tier of the source Filestore instance that this backup is created from.","enum":["TIER_UNSPECIFIED","STANDARD","PREMIUM","BASIC_HDD","BASIC_SSD","HIGH_SCALE_SSD","ENTERPRISE","ZONAL","REGIONAL"],"readOnly":true,"type":"string"},"state":{"description":"Output only. The backup state.","enum":["STATE_UNSPECIFIED","CREATING","FINALIZING","READY","DELETING","INVALID"],"readOnly":true,"type":"string"},"storageBytes":{"description":"Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.","format":"int64","readOnly":true,"type":"string"}},"type":"object"},"CancelOperationRequest":{"description":"The request message for Operations.CancelOperation.","properties":{},"type":"object"},"DailyCycle":{"description":"Time window specified for daily operations.","properties":{"duration":{"description":"Output only. Duration of the time window, set by service producer.","format":"google-duration","type":"string"},"startTime":{"$ref":"#/components/schemas/TimeOfDay","description":"Time within the day to start the operations."}},"type":"object"},"Date":{"description":"Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp","properties":{"day":{"description":"Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.","format":"int32","type":"integer"},"month":{"description":"Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.","format":"int32","type":"integer"},"year":{"description":"Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.","format":"int32","type":"integer"}},"type":"object"},"DenyMaintenancePeriod":{"description":"DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.","properties":{"endDate":{"$ref":"#/components/schemas/Date","description":"Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end."},"startDate":{"$ref":"#/components/schemas/Date","description":"Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start."},"time":{"$ref":"#/components/schemas/TimeOfDay","description":"Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC"}},"type":"object"},"Empty":{"description":"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); }","properties":{},"type":"object"},"FileShareConfig":{"description":"File share configuration for the instance.","properties":{"capacityGb":{"description":"File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.","format":"int64","type":"string"},"name":{"description":"Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers. Must use lowercase letters, numbers, or underscores `[a-z0-9_]`. Must start with a letter. Immutable.","type":"string"},"nfsExportOptions":{"description":"Nfs Export Options. There is a limit of 10 export options per file share.","items":{"$ref":"#/components/schemas/NfsExportOptions"},"type":"array"},"sourceBackup":{"description":"The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.","type":"string"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1Instance":{"description":"Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/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/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"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\", } ``` LINT.IfChange","properties":{"consumerDefinedName":{"description":"consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).","type":"string"},"createTime":{"description":"Output only. Timestamp when the resource was created.","format":"google-datetime","readOnly":true,"type":"string"},"instanceType":{"description":"Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"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.","type":"object"},"maintenancePolicyNames":{"additionalProperties":{"type":"string"},"description":"Optional. 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 details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set.","type":"object"},"maintenanceSchedules":{"additionalProperties":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule"},"description":"The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.","type":"object"},"maintenanceSettings":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings","description":"Optional. The MaintenanceSettings associated with instance."},"name":{"description":"Unique name of the resource. It uses the form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.","type":"string"},"notificationParameters":{"additionalProperties":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter"},"description":"Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.","type":"object"},"producerMetadata":{"additionalProperties":{"type":"string"},"description":"Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.","readOnly":true,"type":"object"},"provisionedResources":{"description":"Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.","items":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource"},"readOnly":true,"type":"array"},"slmInstanceTemplate":{"description":"Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.","type":"string"},"sloMetadata":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata","description":"Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.","readOnly":true},"softwareVersions":{"additionalProperties":{"type":"string"},"description":"Software versions that are used to deploy this instance. This can be mutated by rollout services.","type":"object"},"state":{"description":"Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).","enum":["STATE_UNSPECIFIED","CREATING","READY","UPDATING","REPAIRING","DELETING","ERROR"],"readOnly":true,"type":"string"},"tenantProjectId":{"description":"Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.","readOnly":true,"type":"string"},"updateTime":{"description":"Output only. Timestamp when the resource was last modified.","format":"google-datetime","readOnly":true,"type":"string"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule":{"description":"Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule","properties":{"canReschedule":{"deprecated":true,"description":"This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.","type":"boolean"},"endTime":{"description":"The scheduled end time for the maintenance.","format":"google-datetime","type":"string"},"rolloutManagementPolicy":{"description":"The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.","type":"string"},"scheduleDeadlineTime":{"description":"schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline.","format":"google-datetime","type":"string"},"startTime":{"description":"The scheduled start time for the maintenance.","format":"google-datetime","type":"string"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings":{"description":"Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.","properties":{"exclude":{"description":"Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.","type":"boolean"},"isRollback":{"description":"Optional. If the update call is triggered from rollback, set the value as true.","type":"boolean"},"maintenancePolicies":{"additionalProperties":{"$ref":"#/components/schemas/MaintenancePolicy"},"description":"Optional. 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 embedded policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name.","type":"object"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata":{"description":"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.","properties":{"location":{"description":"The location of the node, if different from instance location.","type":"string"},"nodeId":{"description":"The id of the node. This should be equal to SaasInstanceNode.node_id.","type":"string"},"perSliEligibility":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility","description":"If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs."}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter":{"description":"Contains notification related data.","properties":{"values":{"description":"Optional. Array of string values. e.g. instance's replica information.","items":{"type":"string"},"type":"array"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility":{"description":"PerSliSloEligibility is a mapping from an SLI name to eligibility.","properties":{"eligibilities":{"additionalProperties":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility"},"description":"An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.","type":"object"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource":{"description":"Describes provisioned dataplane resources.","properties":{"resourceType":{"description":"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'.","type":"string"},"resourceUrl":{"description":"URL identifying the resource, e.g. \"https://www.googleapis.com/compute/v1/projects/...)\".","type":"string"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility":{"description":"SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.","properties":{"eligible":{"description":"Whether an instance is eligible or ineligible.","type":"boolean"},"reason":{"description":"User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.","type":"string"}},"type":"object"},"GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata":{"description":"SloMetadata contains resources required for proper SLO classification of the instance.","properties":{"nodes":{"description":"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.","items":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata"},"type":"array"},"perSliEligibility":{"$ref":"#/components/schemas/GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility","description":"Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs."},"tier":{"description":"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.","type":"string"}},"type":"object"},"Instance":{"description":"A Filestore instance.","properties":{"createTime":{"description":"Output only. The time when the instance was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"The description of the instance (2048 characters or less).","type":"string"},"etag":{"description":"Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.","type":"string"},"fileShares":{"description":"File system shares on the instance. For this version, only a single file share is supported.","items":{"$ref":"#/components/schemas/FileShareConfig"},"type":"array"},"kmsKeyName":{"description":"KMS key name used for data encryption.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Resource labels to represent user provided metadata.","type":"object"},"name":{"description":"Output only. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance}`.","readOnly":true,"type":"string"},"networks":{"description":"VPC networks to which the instance is connected. For this version, only a single network is supported.","items":{"$ref":"#/components/schemas/NetworkConfig"},"type":"array"},"satisfiesPzi":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"satisfiesPzs":{"description":"Output only. Reserved for future use.","readOnly":true,"type":"boolean"},"state":{"description":"Output only. The instance state.","enum":["STATE_UNSPECIFIED","CREATING","READY","REPAIRING","DELETING","ERROR","RESTORING","SUSPENDED","SUSPENDING","RESUMING","REVERTING"],"readOnly":true,"type":"string"},"statusMessage":{"description":"Output only. Additional information about the instance state, if available.","readOnly":true,"type":"string"},"suspensionReasons":{"description":"Output only. Field indicates all the reasons the instance is in \"SUSPENDED\" state.","items":{"enum":["SUSPENSION_REASON_UNSPECIFIED","KMS_KEY_ISSUE"],"type":"string"},"readOnly":true,"type":"array"},"tier":{"description":"The service tier of the instance.","enum":["TIER_UNSPECIFIED","STANDARD","PREMIUM","BASIC_HDD","BASIC_SSD","HIGH_SCALE_SSD","ENTERPRISE","ZONAL","REGIONAL"],"type":"string"}},"type":"object"},"ListBackupsResponse":{"description":"ListBackupsResponse is the result of ListBackupsRequest.","properties":{"backups":{"description":"A list of backups in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the \"unreachable\" field will be populated with a list of unreachable locations.","items":{"$ref":"#/components/schemas/Backup"},"type":"array"},"nextPageToken":{"description":"The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.","type":"string"},"unreachable":{"description":"Locations that could not be reached.","items":{"type":"string"},"type":"array"}},"type":"object"},"ListInstancesResponse":{"description":"ListInstancesResponse is the result of ListInstancesRequest.","properties":{"instances":{"description":"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.","items":{"$ref":"#/components/schemas/Instance"},"type":"array"},"nextPageToken":{"description":"The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.","type":"string"},"unreachable":{"description":"Locations that could not be reached.","items":{"type":"string"},"type":"array"}},"type":"object"},"ListLocationsResponse":{"description":"The response message for Locations.ListLocations.","properties":{"locations":{"description":"A list of locations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/Location"},"type":"array"},"nextPageToken":{"description":"The standard List next-page token.","type":"string"}},"type":"object"},"ListOperationsResponse":{"description":"The response message for Operations.ListOperations.","properties":{"nextPageToken":{"description":"The standard List next-page token.","type":"string"},"operations":{"description":"A list of operations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"type":"object"},"ListSnapshotsResponse":{"description":"ListSnapshotsResponse is the result of ListSnapshotsRequest.","properties":{"nextPageToken":{"description":"The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.","type":"string"},"snapshots":{"description":"A list of snapshots in the project for the specified instance.","items":{"$ref":"#/components/schemas/Snapshot"},"type":"array"}},"type":"object"},"Location":{"description":"A resource that represents a Google Cloud location.","properties":{"displayName":{"description":"The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}","type":"object"},"locationId":{"description":"The canonical id for this location. For example: `\"us-east1\"`.","type":"string"},"metadata":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"Service-specific metadata. For example the available capacity at the given location.","type":"object"},"name":{"description":"Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`","type":"string"}},"type":"object"},"MaintenancePolicy":{"description":"LINT.IfChange Defines policies to service maintenance events.","properties":{"createTime":{"description":"Output only. The time when the resource was created.","format":"google-datetime","type":"string"},"description":{"description":"Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"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.","type":"object"},"name":{"description":"Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GC