Ballerina library

googleapis.cloudfilestore

Module googleapis.cloudfilestore

OverviewPrerequisites

API

Client

Definitions

Backup
ClientHttp1Settings
ConnectionConfig
DailyCycle
Date
DenyMaintenancePeriod
FileShareConfig
GoogleCloudSaasacceleratorManagementProvidersV1Instance
GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule
GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings
GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata
GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility
GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource
GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility
GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion
GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata
Instance
ListBackupsResponse
ListInstancesResponse
ListLocationsResponse
ListOperationsResponse
Location
MaintenancePolicy
MaintenanceWindow
NetworkConfig
NfsExportOptions
OAuth2RefreshTokenGrantConfig
Operation
OperationMetadata
ProxyConfig
RestoreInstanceRequest
Schedule
Status
TimeOfDay
UpdatePolicy
WeeklyCycle

ballerinax/googleapis.cloudfilestore Ballerina library

1.5.2

Overview

The Google Cloud Filestore REST API v1 connector(https://cloud.google.com/filestore/docs/reference/rest) OpenAPI specification. The Google Cloud Filestore API provides the capability to create and manage cloud file servers.

Key Features

  • Programmatic access to create and manage resources via REST API
  • Manage user accounts and profiles
  • Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  1. Create a Google account
  2. Obtain tokens - Follow this guide

Clients

googleapis.cloudfilestore: Client

Isolated

This is a generated connector for Google Cloud Filestore REST API v1 OpenAPI specification. The Google Cloud Filestore API provides the capability to create and manage cloud file servers.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Google account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://file.googleapis.com/" - URL of the target service

getOperation

Isolated FunctionRemote Function
function getOperation(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Operation|error

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.

Parameters
  • name string - The name of the operation resource.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteOperation

Isolated FunctionRemote Function
function deleteOperation(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • name string - The name of the operation resource to be deleted.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

updateInstance

Isolated FunctionRemote Function
function updateInstance(string name, Instance payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns Operation|error

Updates the settings of a specific instance.

Parameters
  • name string - Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
  • payload Instance - Instance to be updated
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • updateMask string? (default ()) - 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"
Return Type

listLocations

Isolated FunctionRemote Function
function listLocations(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, boolean? includeUnrevealedLocations, int? pageSize, string? pageToken) returns ListLocationsResponse|error

Lists information about the supported locations for this service.

Parameters
  • name string - The resource that owns the locations collection, if applicable.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • filter string? (default ()) - 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.
  • includeUnrevealedLocations boolean? (default ()) - If true, the returned list will include locations which are not yet revealed.
  • pageSize int? (default ()) - The maximum number of results to return. If not set, the service selects a default.
  • pageToken string? (default ()) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
Return Type

listOperations

Isolated FunctionRemote Function
function listOperations(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, int? pageSize, string? pageToken) returns ListOperationsResponse|error

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.

Parameters
  • name string - The name of the operation's parent resource.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • filter string? (default ()) - The standard list filter.
  • pageSize int? (default ()) - The standard list page size.
  • pageToken string? (default ()) - The standard list page token.
Return Type

cancelOperation

Isolated FunctionRemote Function
function cancelOperation(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • name string - The name of the operation resource to be cancelled.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

restoreInstance

Isolated FunctionRemote Function
function restoreInstance(string name, RestoreInstanceRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Operation|error

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).

Parameters
  • name string - Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listBackups

Isolated FunctionRemote Function
function listBackups(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, string? orderBy, int? pageSize, string? pageToken) returns ListBackupsResponse|error

Lists all backups in a project for either a specified location or for all locations.

Parameters
  • parent string - Required. The project and location for which to retrieve backup information, in the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example us-west1. To retrieve backup information for all locations, use "-" for the {location} value.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • filter string? (default ()) - List filter.
  • orderBy string? (default ()) - Sort results. Supported values are "name", "name desc" or "" (unsorted).
  • pageSize int? (default ()) - The maximum number of items to return.
  • pageToken string? (default ()) - The next_page_token value to use if there are additional results to retrieve for this list request.
Return Type

createBackup

Isolated FunctionRemote Function
function createBackup(string parent, Backup payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? backupId) returns Operation|error

Creates a backup.

Parameters
  • parent string - Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example us-west1.
  • payload Backup - Backup to be created
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • backupId string? (default ()) - 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.
Return Type

listInstances

Isolated FunctionRemote Function
function listInstances(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, string? orderBy, int? pageSize, string? pageToken) returns ListInstancesResponse|error

Lists all instances in a project for either a specified location or for all locations.

Parameters
  • parent string - 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 GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • filter string? (default ()) - List filter.
  • orderBy string? (default ()) - Sort results. Supported values are "name", "name desc" or "" (unsorted).
  • pageSize int? (default ()) - The maximum number of items to return.
  • pageToken string? (default ()) - The next_page_token value to use if there are additional results to retrieve for this list request.
Return Type

createInstance

Isolated FunctionRemote Function
function createInstance(string parent, Instance payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? instanceId) returns Operation|error

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).

Parameters
  • parent string - Required. 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.
  • payload Instance - Instance to be created
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - 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.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • instanceId string? (default ()) - Required. The name of the instance to create. The name must be unique for the specified project and location.
Return Type

Records

googleapis.cloudfilestore: Backup

A Cloud Filestore backup.

Fields
  • capacityGb? string - Output only. Capacity of the source file share when the backup was created.
  • createTime? string - Output only. The time when the backup was created.
  • description? string - A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
  • downloadBytes? string - 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.
  • labels? record {} - Resource labels to represent user provided metadata.
  • name? string - Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.
  • satisfiesPzs? boolean - Output only. Reserved for future use.
  • sourceFileShare? string - Name of the file share in the source Cloud Filestore instance that the backup is created from.
  • sourceInstance? string - The resource name of the source Cloud Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.
  • sourceInstanceTier? string - Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
  • state? string - Output only. The backup state.
  • storageBytes? string - 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.

googleapis.cloudfilestore: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

googleapis.cloudfilestore: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache? CacheConfig - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig? RetryConfig - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.cloudfilestore: DailyCycle

Time window specified for daily operations.

Fields
  • duration? string - Output only. Duration of the time window, set by service producer.
  • startTime? TimeOfDay - Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

googleapis.cloudfilestore: Date

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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

Fields
  • day? int - 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.
  • month? int - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  • year? int - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

googleapis.cloudfilestore: DenyMaintenancePeriod

DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.

Fields
  • endDate? Date - 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.
  • startDate? Date - 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.
  • time? TimeOfDay - Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

googleapis.cloudfilestore: FileShareConfig

File share configuration for the instance.

Fields
  • capacityGb? string - File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
  • name? string - The name of the file share (must be 16 characters or less).
  • nfsExportOptions? NfsExportOptions[] - Nfs Export Options. There is a limit of 10 export options per file share.
  • sourceBackup? string - 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.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1Instance

Fields
  • 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.
  • createTime? string - Output only. Timestamp when the resource was created.
  • labels? record {} - 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.
  • maintenancePolicyNames? record {} - Deprecated. 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.
  • maintenanceSchedules? record {} - The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.
  • name? string - Unique name of the resource. It uses the form: projects/{project_id|project_number}/locations/{location_id}/instances/{instance_id} Note: Either project_id or project_number can be used, but keep it consistent with other APIs (e.g. RescheduleUpdate)
  • producerMetadata? record {} - Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.
  • slmInstanceTemplate? string - 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.
  • softwareVersions? record {} - Software versions that are used to deploy this instance. This can be mutated by rollout services.
  • state? string - Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
  • tenantProjectId? string - Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.
  • updateTime? string - Output only. Timestamp when the resource was last modified.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule

Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule

Fields
  • canReschedule? boolean - 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.
  • endTime? string - The scheduled end 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.
  • scheduleDeadlineTime? string - 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.
  • startTime? string - The scheduled start time for the maintenance.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings

Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.

Fields
  • exclude? boolean - 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.
  • isRollback? boolean - Optional. If the update call is triggered from rollback, set the value as true.
  • maintenancePolicies? record {} - 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 complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata

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.

Fields
  • exclusions? 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.
  • location? string - The location of the node, if different from instance location.
  • nodeId? string - The id of the node. This should be equal to SaasInstanceNode.node_id.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility

PerSliSloEligibility is a mapping from an SLI name to eligibility.

Fields
  • eligibilities? record {} - 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.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource

Describes provisioned dataplane resources.

Fields
  • 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'.
  • resourceUrl? string - URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)".

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility

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.

Fields
  • eligible? boolean - Whether an instance is eligible or ineligible.
  • reason? string - 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.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion

SloExclusion represents an exclusion in SLI calculation applies to all SLOs.

Fields
  • duration? 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.
  • 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.
  • 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.
  • startTime? string - Start time of the exclusion. No alignment (e.g. to a full minute) needed.

googleapis.cloudfilestore: GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata

SloMetadata contains resources required for proper SLO classification of the instance.

Fields
  • exclusions? 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, use of custom instance eligibility is recommended. See 'eligibility' field below.
  • nodes? 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.
  • 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.

googleapis.cloudfilestore: Instance

A Cloud Filestore instance.

Fields
  • createTime? string - Output only. The time when the instance was created.
  • description? string - The description of the instance (2048 characters or less).
  • etag? string - Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
  • fileShares? FileShareConfig[] - File system shares on the instance. For this version, only a single file share is supported.
  • labels? record {} - Resource labels to represent user provided metadata.
  • name? string - Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
  • networks? NetworkConfig[] - VPC networks to which the instance is connected. For this version, only a single network is supported.
  • satisfiesPzs? boolean - Output only. Reserved for future use.
  • state? string - Output only. The instance state.
  • statusMessage? string - Output only. Additional information about the instance state, if available.
  • tier? string - The service tier of the instance.

googleapis.cloudfilestore: ListBackupsResponse

ListBackupsResponse is the result of ListBackupsRequest.

Fields
  • backups? Backup[] - 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.
  • 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.
  • unreachable? string[] - Locations that could not be reached.

googleapis.cloudfilestore: ListInstancesResponse

ListInstancesResponse is the result of ListInstancesRequest.

Fields
  • instances? 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.
  • 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.
  • unreachable? string[] - Locations that could not be reached.

googleapis.cloudfilestore: ListLocationsResponse

The response message for Locations.ListLocations.

Fields
  • locations? Location[] - A list of locations that matches the specified filter in the request.
  • nextPageToken? string - The standard List next-page token.

googleapis.cloudfilestore: ListOperationsResponse

The response message for Operations.ListOperations.

Fields
  • nextPageToken? string - The standard List next-page token.
  • operations? Operation[] - A list of operations that matches the specified filter in the request.

googleapis.cloudfilestore: Location

A resource that represents Google Cloud Platform location.

Fields
  • displayName? string - The friendly name for this location, typically a nearby city name. For example, "Tokyo".
  • labels? record {} - Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
  • locationId? string - The canonical id for this location. For example: "us-east1".
  • metadata? record {} - Service-specific metadata. For example the available capacity at the given location.
  • name? string - Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

googleapis.cloudfilestore: MaintenancePolicy

Defines policies to service maintenance events.

Fields
  • createTime? string - Output only. The time when the resource was created.
  • description? string - Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
  • labels? record {} - 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.
  • name? string - 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 GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression [a-z0-9]([-a-z0-9]*[a-z0-9])?.
  • state? string - Optional. The state of the policy.
  • updatePolicy? UpdatePolicy - Maintenance policy applicable to instance updates.
  • updateTime? string - Output only. The time when the resource was updated.

googleapis.cloudfilestore: MaintenanceWindow

MaintenanceWindow definition.

Fields
  • dailyCycle? DailyCycle - Time window specified for daily operations.
  • weeklyCycle? WeeklyCycle - Time window specified for weekly operations.

googleapis.cloudfilestore: NetworkConfig

Network configuration for the instance.

Fields
  • ipAddresses? 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}.
  • modes? string[] - Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
  • network? string - The name of the Google Compute Engine VPC network to which the instance is connected.
  • 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.

googleapis.cloudfilestore: NfsExportOptions

NFS export options specifications.

Fields
  • accessMode? string - Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
  • anonGid? string - An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
  • anonUid? string - An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
  • ipRanges? string[] - List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
  • squashMode? string - Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

googleapis.cloudfilestore: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.cloudfilestore: Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
  • 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? Status - 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.
  • metadata? record {} - 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.
  • 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}.
  • response? record {} - 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.

googleapis.cloudfilestore: OperationMetadata

Represents the metadata of the long-running operation.

Fields
  • apiVersion? string - Output only. API version used to start the operation.
  • 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 Code.CANCELLED.
  • createTime? string - Output only. The time the operation was created.
  • endTime? string - Output only. The time the operation finished running.
  • statusDetail? string - Output only. Human-readable status of the operation, if any.
  • target? string - Output only. Server-defined resource path for the target of the operation.
  • verb? string - Output only. Name of the verb executed by the operation.

googleapis.cloudfilestore: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

googleapis.cloudfilestore: RestoreInstanceRequest

RestoreInstanceRequest restores an existing instances's file share from a backup.

Fields
  • fileShare? string - Required. Name of the file share in the Cloud Filestore instance that the backup is being restored to.
  • sourceBackup? string - The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

googleapis.cloudfilestore: Schedule

Configure the schedule.

Fields
  • day? string - Allows to define schedule that runs specified day of the week.
  • duration? string - Output only. Duration of the time window, set by service producer.
  • startTime? TimeOfDay - Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

googleapis.cloudfilestore: Status

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.

Fields
  • code? int - The status code, which should be an enum value of google.rpc.Code.
  • details? record {}[] - A list of messages that carry the error details. There is a common set of message types for APIs to use.
  • 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.

googleapis.cloudfilestore: TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Fields
  • hours? int - Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
  • minutes? int - Minutes of hour of day. Must be from 0 to 59.
  • nanos? int - Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
  • seconds? int - Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

googleapis.cloudfilestore: UpdatePolicy

Maintenance policy applicable to instance updates.

Fields
  • channel? string - Optional. Relative scheduling channel applied to resource.
  • denyMaintenancePeriods? DenyMaintenancePeriod[] - Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. Maximum number of deny_maintenance_periods expected is one.

googleapis.cloudfilestore: WeeklyCycle

Time window specified for weekly operations.

Fields
  • schedule? Schedule[] - User can specify multiple windows in a week. Minimum of 1 window.

Import

import ballerinax/googleapis.cloudfilestore;Copy

Other versions

1.5.2

1.5.11.5.01.4.01.2.0
See more...

Metadata

Released date: 3 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 39

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Content & Files/File Management & Storage

Cost/Paid

Vendor/Google

Area/Storage & File Management

Contributors

Dependencies

ballerina/url/2.4.0ballerina/http/2.10.24

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2026 WSO2 LLC