file
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package file provides access to the Cloud Filestore API.
For product documentation, see:https://cloud.google.com/filestore/
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/file/v1"...ctx := context.Background()fileService, err := file.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
fileService, err := file.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)fileService, err := file.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type Backup
- type CancelOperationRequest
- type DailyCycle
- type Date
- type DenyMaintenancePeriod
- type DirectoryServicesConfig
- type Empty
- type FileShareConfig
- type FixedIOPS
- type GoogleCloudSaasacceleratorManagementProvidersV1Instance
- type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule
- type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings
- type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata
- type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter
- type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility
- type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource
- type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility
- type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata
- type IOPSPerTB
- type Instance
- type LdapConfig
- type ListBackupsResponse
- type ListInstancesResponse
- type ListLocationsResponse
- type ListOperationsResponse
- type ListSnapshotsResponse
- type Location
- type MaintenancePolicy
- type MaintenanceWindow
- type NetworkConfig
- type NfsExportOptions
- type Operation
- type OperationMetadata
- type PerformanceConfig
- type PerformanceLimits
- type ProjectsLocationsBackupsCreateCall
- func (c *ProjectsLocationsBackupsCreateCall) BackupId(backupId string) *ProjectsLocationsBackupsCreateCall
- func (c *ProjectsLocationsBackupsCreateCall) Context(ctx context.Context) *ProjectsLocationsBackupsCreateCall
- func (c *ProjectsLocationsBackupsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsBackupsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsCreateCall
- func (c *ProjectsLocationsBackupsCreateCall) Header() http.Header
- type ProjectsLocationsBackupsDeleteCall
- func (c *ProjectsLocationsBackupsDeleteCall) Context(ctx context.Context) *ProjectsLocationsBackupsDeleteCall
- func (c *ProjectsLocationsBackupsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsBackupsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsDeleteCall
- func (c *ProjectsLocationsBackupsDeleteCall) Header() http.Header
- type ProjectsLocationsBackupsGetCall
- func (c *ProjectsLocationsBackupsGetCall) Context(ctx context.Context) *ProjectsLocationsBackupsGetCall
- func (c *ProjectsLocationsBackupsGetCall) Do(opts ...googleapi.CallOption) (*Backup, error)
- func (c *ProjectsLocationsBackupsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsGetCall
- func (c *ProjectsLocationsBackupsGetCall) Header() http.Header
- func (c *ProjectsLocationsBackupsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsBackupsGetCall
- type ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) Context(ctx context.Context) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) Do(opts ...googleapi.CallOption) (*ListBackupsResponse, error)
- func (c *ProjectsLocationsBackupsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) Filter(filter string) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) Header() http.Header
- func (c *ProjectsLocationsBackupsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) OrderBy(orderBy string) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) PageSize(pageSize int64) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) PageToken(pageToken string) *ProjectsLocationsBackupsListCall
- func (c *ProjectsLocationsBackupsListCall) Pages(ctx context.Context, f func(*ListBackupsResponse) error) error
- type ProjectsLocationsBackupsPatchCall
- func (c *ProjectsLocationsBackupsPatchCall) Context(ctx context.Context) *ProjectsLocationsBackupsPatchCall
- func (c *ProjectsLocationsBackupsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsBackupsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsPatchCall
- func (c *ProjectsLocationsBackupsPatchCall) Header() http.Header
- func (c *ProjectsLocationsBackupsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsBackupsPatchCall
- type ProjectsLocationsBackupsService
- func (r *ProjectsLocationsBackupsService) Create(parent string, backup *Backup) *ProjectsLocationsBackupsCreateCall
- func (r *ProjectsLocationsBackupsService) Delete(name string) *ProjectsLocationsBackupsDeleteCall
- func (r *ProjectsLocationsBackupsService) Get(name string) *ProjectsLocationsBackupsGetCall
- func (r *ProjectsLocationsBackupsService) List(parent string) *ProjectsLocationsBackupsListCall
- func (r *ProjectsLocationsBackupsService) Patch(name string, backup *Backup) *ProjectsLocationsBackupsPatchCall
- type ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Header() http.Header
- func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
- type ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Header() http.Header
- func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceId string) *ProjectsLocationsInstancesCreateCall
- type ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Force(force bool) *ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Header() http.Header
- type ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance, error)
- func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Header() http.Header
- func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesGetCall
- type ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)
- func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Filter(filter string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Header() http.Header
- func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error
- type ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Header() http.Header
- func (c *ProjectsLocationsInstancesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesPatchCall
- type ProjectsLocationsInstancesPromoteReplicaCall
- func (c *ProjectsLocationsInstancesPromoteReplicaCall) Context(ctx context.Context) *ProjectsLocationsInstancesPromoteReplicaCall
- func (c *ProjectsLocationsInstancesPromoteReplicaCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesPromoteReplicaCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPromoteReplicaCall
- func (c *ProjectsLocationsInstancesPromoteReplicaCall) Header() http.Header
- type ProjectsLocationsInstancesRestoreCall
- func (c *ProjectsLocationsInstancesRestoreCall) Context(ctx context.Context) *ProjectsLocationsInstancesRestoreCall
- func (c *ProjectsLocationsInstancesRestoreCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesRestoreCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRestoreCall
- func (c *ProjectsLocationsInstancesRestoreCall) Header() http.Header
- type ProjectsLocationsInstancesRevertCall
- func (c *ProjectsLocationsInstancesRevertCall) Context(ctx context.Context) *ProjectsLocationsInstancesRevertCall
- func (c *ProjectsLocationsInstancesRevertCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesRevertCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRevertCall
- func (c *ProjectsLocationsInstancesRevertCall) Header() http.Header
- type ProjectsLocationsInstancesService
- func (r *ProjectsLocationsInstancesService) Create(parent string, instance *Instance) *ProjectsLocationsInstancesCreateCall
- func (r *ProjectsLocationsInstancesService) Delete(name string) *ProjectsLocationsInstancesDeleteCall
- func (r *ProjectsLocationsInstancesService) Get(name string) *ProjectsLocationsInstancesGetCall
- func (r *ProjectsLocationsInstancesService) List(parent string) *ProjectsLocationsInstancesListCall
- func (r *ProjectsLocationsInstancesService) Patch(name string, instance *Instance) *ProjectsLocationsInstancesPatchCall
- func (r *ProjectsLocationsInstancesService) PromoteReplica(name string, promotereplicarequest *PromoteReplicaRequest) *ProjectsLocationsInstancesPromoteReplicaCall
- func (r *ProjectsLocationsInstancesService) Restore(name string, restoreinstancerequest *RestoreInstanceRequest) *ProjectsLocationsInstancesRestoreCall
- func (r *ProjectsLocationsInstancesService) Revert(name string, revertinstancerequest *RevertInstanceRequest) *ProjectsLocationsInstancesRevertCall
- type ProjectsLocationsInstancesSnapshotsCreateCall
- func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsCreateCall
- func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsCreateCall
- func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Header() http.Header
- func (c *ProjectsLocationsInstancesSnapshotsCreateCall) SnapshotId(snapshotId string) *ProjectsLocationsInstancesSnapshotsCreateCall
- type ProjectsLocationsInstancesSnapshotsDeleteCall
- func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsDeleteCall
- func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsDeleteCall
- func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Header() http.Header
- type ProjectsLocationsInstancesSnapshotsGetCall
- func (c *ProjectsLocationsInstancesSnapshotsGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsGetCall
- func (c *ProjectsLocationsInstancesSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)
- func (c *ProjectsLocationsInstancesSnapshotsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsGetCall
- func (c *ProjectsLocationsInstancesSnapshotsGetCall) Header() http.Header
- func (c *ProjectsLocationsInstancesSnapshotsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSnapshotsGetCall
- type ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Filter(filter string) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Header() http.Header
- func (c *ProjectsLocationsInstancesSnapshotsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) PageToken(pageToken string) *ProjectsLocationsInstancesSnapshotsListCall
- func (c *ProjectsLocationsInstancesSnapshotsListCall) Pages(ctx context.Context, f func(*ListSnapshotsResponse) error) error
- func (c *ProjectsLocationsInstancesSnapshotsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsInstancesSnapshotsListCall
- type ProjectsLocationsInstancesSnapshotsPatchCall
- func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsPatchCall
- func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsPatchCall
- func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Header() http.Header
- func (c *ProjectsLocationsInstancesSnapshotsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesSnapshotsPatchCall
- type ProjectsLocationsInstancesSnapshotsService
- func (r *ProjectsLocationsInstancesSnapshotsService) Create(parent string, snapshot *Snapshot) *ProjectsLocationsInstancesSnapshotsCreateCall
- func (r *ProjectsLocationsInstancesSnapshotsService) Delete(name string) *ProjectsLocationsInstancesSnapshotsDeleteCall
- func (r *ProjectsLocationsInstancesSnapshotsService) Get(name string) *ProjectsLocationsInstancesSnapshotsGetCall
- func (r *ProjectsLocationsInstancesSnapshotsService) List(parent string) *ProjectsLocationsInstancesSnapshotsListCall
- func (r *ProjectsLocationsInstancesSnapshotsService) Patch(name string, snapshot *Snapshot) *ProjectsLocationsInstancesSnapshotsPatchCall
- type ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
- func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Header() http.Header
- func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
- type ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
- type ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsOperationsService
- func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
- func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
- func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
- func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsService
- type ProjectsService
- type PromoteReplicaRequest
- type PscConfig
- type ReplicaConfig
- type Replication
- type RestoreInstanceRequest
- type RevertInstanceRequest
- type Schedule
- type Service
- type Snapshot
- type Status
- type TimeOfDay
- type UpdatePolicy
- type WeeklyCycle
Constants¶
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBackup¶added inv0.35.0
type Backup struct {// CapacityGb: Output only. Capacity of the source file share when the backup// was created.CapacityGbint64 `json:"capacityGb,omitempty,string"`// CreateTime: Output only. The time when the backup was created.CreateTimestring `json:"createTime,omitempty"`// Description: A description of the backup with 2048 characters or less.// Requests with longer descriptions will be rejected.Descriptionstring `json:"description,omitempty"`// DownloadBytes: 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.DownloadBytesint64 `json:"downloadBytes,omitempty,string"`// FileSystemProtocol: Output only. The file system protocol of the source// Filestore instance that this backup is created from.//// Possible values:// "FILE_PROTOCOL_UNSPECIFIED" - FILE_PROTOCOL_UNSPECIFIED serves a "not set"// default value when a FileProtocol is a separate field in a message.// "NFS_V3" - NFS 3.0.// "NFS_V4_1" - NFS 4.1.FileSystemProtocolstring `json:"fileSystemProtocol,omitempty"`// KmsKey: Immutable. KMS key name used for data encryption.KmsKeystring `json:"kmsKey,omitempty"`// Labels: Resource labels to represent user provided metadata.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The resource name of the backup, in the format// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.Namestring `json:"name,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// SourceFileShare: Name of the file share in the source Filestore instance// that the backup is created from.SourceFileSharestring `json:"sourceFileShare,omitempty"`// SourceInstance: 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.SourceInstancestring `json:"sourceInstance,omitempty"`// SourceInstanceTier: Output only. The service tier of the source Filestore// instance that this backup is created from.//// Possible values:// "TIER_UNSPECIFIED" - Not set.// "STANDARD" - STANDARD tier. BASIC_HDD is the preferred term for this tier.// "PREMIUM" - PREMIUM tier. BASIC_SSD is the preferred term for this tier.// "BASIC_HDD" - BASIC instances offer a maximum capacity of 63.9 TB.// BASIC_HDD is an alias for STANDARD Tier, offering economical performance// backed by HDD.// "BASIC_SSD" - BASIC instances offer a maximum capacity of 63.9 TB.// BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance// backed by SSD.// "HIGH_SCALE_SSD" - HIGH_SCALE instances offer expanded capacity and// performance scaling capabilities.// "ENTERPRISE" - ENTERPRISE instances offer the features and availability// needed for mission-critical workloads.// "ZONAL" - ZONAL instances offer expanded capacity and performance scaling// capabilities.// "REGIONAL" - REGIONAL instances offer the features and availability needed// for mission-critical workloads.SourceInstanceTierstring `json:"sourceInstanceTier,omitempty"`// State: Output only. The backup state.//// Possible values:// "STATE_UNSPECIFIED" - State not set.// "CREATING" - Backup is being created.// "FINALIZING" - Backup has been taken and the operation is being finalized.// At this point, changes to the file share will not be reflected in the// backup.// "READY" - Backup is available for use.// "DELETING" - Backup is being deleted.// "INVALID" - Backup is not valid and cannot be used for creating new// instances or restoring existing instances.Statestring `json:"state,omitempty"`// StorageBytes: 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.StorageBytesint64 `json:"storageBytes,omitempty,string"`// Tags: Optional. Input only. Immutable. Tag key-value pairs bound to this// resource. Each key must be a namespaced name and each value a short name.// Example: "123456789012/environment" : "production",// "123456789013/costCenter" : "marketing" See the documentation for more// information: - Namespaced name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key// - Short name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_valueTags map[string]string `json:"tags,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CapacityGb") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CapacityGb") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Backup: A Filestore backup.
func (Backup)MarshalJSON¶added inv0.35.0
typeCancelOperationRequest¶
type CancelOperationRequest struct {}CancelOperationRequest: The request message for Operations.CancelOperation.
typeDailyCycle¶added inv0.35.0
type DailyCycle struct {// Duration: Output only. Duration of the time window, set by service producer.Durationstring `json:"duration,omitempty"`// StartTime: Time within the day to start the operations.StartTime *TimeOfDay `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Duration") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Duration") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DailyCycle: Time window specified for daily operations.
func (DailyCycle)MarshalJSON¶added inv0.35.0
func (sDailyCycle) MarshalJSON() ([]byte,error)
typeDate¶added inv0.35.0
type Date struct {// Day: 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.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Date: Represents a whole or partial calendar date, such as a birthday. Thetime of day and time zone are either specified elsewhere or areinsignificant. The date is relative to the Gregorian Calendar. This canrepresent 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, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp
func (Date)MarshalJSON¶added inv0.35.0
typeDenyMaintenancePeriod¶added inv0.35.0
type DenyMaintenancePeriod struct {// EndDate: 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.EndDate *Date `json:"endDate,omitempty"`// StartDate: 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.StartDate *Date `json:"startDate,omitempty"`// Time: 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 UTCTime *TimeOfDay `json:"time,omitempty"`// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndDate") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DenyMaintenancePeriod: DenyMaintenancePeriod definition. Maintenance isforbidden within the deny period. The start_date must be less than theend_date.
func (DenyMaintenancePeriod)MarshalJSON¶added inv0.35.0
func (sDenyMaintenancePeriod) MarshalJSON() ([]byte,error)
typeDirectoryServicesConfig¶added inv0.254.0
type DirectoryServicesConfig struct {// Ldap: Configuration for LDAP servers.Ldap *LdapConfig `json:"ldap,omitempty"`// ForceSendFields is a list of field names (e.g. "Ldap") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Ldap") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DirectoryServicesConfig: Directory Services configuration for Kerberos-basedauthentication.
func (DirectoryServicesConfig)MarshalJSON¶added inv0.254.0
func (sDirectoryServicesConfig) MarshalJSON() ([]byte,error)
typeEmpty¶
type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
typeFileShareConfig¶
type FileShareConfig struct {// CapacityGb: File share capacity in gigabytes (GB). Filestore defines 1 GB as// 1024^3 bytes.CapacityGbint64 `json:"capacityGb,omitempty,string"`// Name: 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.Namestring `json:"name,omitempty"`// NfsExportOptions: Nfs Export Options. There is a limit of 10 export options// per file share.NfsExportOptions []*NfsExportOptions `json:"nfsExportOptions,omitempty"`// SourceBackup: 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.SourceBackupstring `json:"sourceBackup,omitempty"`// SourceBackupdrBackup: The resource name of the BackupDR backup, in the// format// `projects/{project_id}/locations/{location_id}/backupVaults/{backupvault_id}/// dataSources/{datasource_id}/backups/{backup_id}`, TODO (b/443690479) -// Remove visibility restrictions once the feature is readySourceBackupdrBackupstring `json:"sourceBackupdrBackup,omitempty"`// ForceSendFields is a list of field names (e.g. "CapacityGb") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CapacityGb") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}FileShareConfig: File share configuration for the instance.
func (FileShareConfig)MarshalJSON¶
func (sFileShareConfig) MarshalJSON() ([]byte,error)
typeFixedIOPS¶added inv0.187.0
type FixedIOPS struct {// MaxIops: Required. Maximum IOPS.MaxIopsint64 `json:"maxIops,omitempty,string"`// ForceSendFields is a list of field names (e.g. "MaxIops") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxIops") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}FixedIOPS: Fixed IOPS (input/output operations per second) parameters.
func (FixedIOPS)MarshalJSON¶added inv0.187.0
typeGoogleCloudSaasacceleratorManagementProvidersV1Instance¶added inv0.4.0
type GoogleCloudSaasacceleratorManagementProvidersV1Instance struct {// ConsumerDefinedName: 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).ConsumerDefinedNamestring `json:"consumerDefinedName,omitempty"`// ConsumerProjectNumber: Optional. The consumer_project_number associated with// this Apigee instance. This field is added specifically to support Apigee// integration with SLM Rollout and UMM. It represents the numerical project ID// of the GCP project that consumes this Apigee instance. It is used for SLM// rollout notifications and UMM integration, enabling proper mapping to// customer projects and log delivery for Apigee instances. This field// complements consumer_project_id and may be used for specific Apigee// scenarios where the numerical ID is required.ConsumerProjectNumberstring `json:"consumerProjectNumber,omitempty"`// CreateTime: Output only. Timestamp when the resource was created.CreateTimestring `json:"createTime,omitempty"`// InstanceType: Optional. The instance_type of this instance of format:// projects/{project_number}/locations/{location_id}/instanceTypes/{instance_typ// e_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.InstanceTypestring `json:"instanceType,omitempty"`// Labels: 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.Labels map[string]string `json:"labels,omitempty"`// MaintenancePolicyNames: 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.MaintenancePolicyNames map[string]string `json:"maintenancePolicyNames,omitempty"`// MaintenanceSchedules: The MaintenanceSchedule contains the scheduling// information of published maintenance schedule with same key as// software_versions.MaintenanceSchedules map[string]GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule `json:"maintenanceSchedules,omitempty"`// MaintenanceSettings: Optional. The MaintenanceSettings associated with// instance.MaintenanceSettings *GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings `json:"maintenanceSettings,omitempty"`// Name: 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.Namestring `json:"name,omitempty"`// NotificationParameters: 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.NotificationParameters map[string]GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter `json:"notificationParameters,omitempty"`// ProducerMetadata: Output only. Custom string attributes used primarily to// expose producer-specific information in monitoring dashboards. See// go/get-instance-metadata.ProducerMetadata map[string]string `json:"producerMetadata,omitempty"`// ProvisionedResources: Output only. The list of data plane resources// provisioned for this instance, e.g. compute VMs. See// go/get-instance-metadata.ProvisionedResources []*GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource `json:"provisionedResources,omitempty"`// SlmInstanceTemplate: 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.SlmInstanceTemplatestring `json:"slmInstanceTemplate,omitempty"`// SloMetadata: Output only. SLO metadata for instance classification in the// Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for// feature description.SloMetadata *GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata `json:"sloMetadata,omitempty"`// SoftwareVersions: Software versions that are used to deploy this instance.// This can be mutated by rollout services.SoftwareVersions map[string]string `json:"softwareVersions,omitempty"`// State: Output only. Current lifecycle state of the resource (e.g. if it's// being created or ready to use).//// Possible values:// "STATE_UNSPECIFIED" - Unspecified state.// "CREATING" - Instance is being created.// "READY" - Instance has been created and is ready to use.// "UPDATING" - Instance is being updated.// "REPAIRING" - Instance is unheathy and under repair.// "DELETING" - Instance is being deleted.// "ERROR" - Instance encountered an error and is in indeterministic state.Statestring `json:"state,omitempty"`// TenantProjectId: Output only. ID of the associated GCP tenant project. See// go/get-instance-metadata.TenantProjectIdstring `json:"tenantProjectId,omitempty"`// UpdateTime: Output only. Timestamp when the resource was last modified.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "ConsumerDefinedName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConsumerDefinedName") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1Instance: Instance representsthe interface for SLM services to actuate the state of control planeresources. 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
func (GoogleCloudSaasacceleratorManagementProvidersV1Instance)MarshalJSON¶added inv0.4.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1Instance) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule¶added inv0.6.0
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule struct {// CanReschedule: 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.CanReschedulebool `json:"canReschedule,omitempty"`// EndTime: The scheduled end time for the maintenance.EndTimestring `json:"endTime,omitempty"`// RolloutManagementPolicy: The rollout management policy this maintenance// schedule is associated with. When doing reschedule update request, the// reschedule should be against this given policy.RolloutManagementPolicystring `json:"rolloutManagementPolicy,omitempty"`// ScheduleDeadlineTime: 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.ScheduleDeadlineTimestring `json:"scheduleDeadlineTime,omitempty"`// StartTime: The scheduled start time for the maintenance.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CanReschedule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CanReschedule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule:Maintenance schedule which is exposed to customer and potentially end user,indicating published upcoming future maintenance schedule
func (GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule)MarshalJSON¶added inv0.6.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings¶added inv0.26.0
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings struct {// Exclude: 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.Excludebool `json:"exclude,omitempty"`// IsRollback: Optional. If the update call is triggered from rollback, set the// value as true.IsRollbackbool `json:"isRollback,omitempty"`// MaintenancePolicies: 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.MaintenancePolicies map[string]MaintenancePolicy `json:"maintenancePolicies,omitempty"`// ForceSendFields is a list of field names (e.g. "Exclude") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Exclude") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings:Maintenance settings associated with instance. Allows service producers andend users to assign settings that controls maintenance on this instance.
func (GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings)MarshalJSON¶added inv0.26.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata¶added inv0.6.0
type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata struct {// Location: The location of the node, if different from instance location.Locationstring `json:"location,omitempty"`// NodeId: The id of the node. This should be equal to// SaasInstanceNode.node_id.NodeIdstring `json:"nodeId,omitempty"`// PerSliEligibility: If present, this will override eligibility for the node// coming from instance or exclusions for specified SLIs.PerSliEligibility *GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility `json:"perSliEligibility,omitempty"`// ForceSendFields is a list of field names (e.g. "Location") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Location") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata: Nodeinformation for custom per-node SLO implementations. SSA does not supportper-node SLO, but producers can populate per-node information in SloMetadatafor custom precomputations. SSA Eligibility Exporter will emit per-nodemetric based on this information.
func (GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata)MarshalJSON¶added inv0.6.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter¶added inv0.75.0
type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter struct {// Values: Optional. Array of string values. e.g. instance's replica// information.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter:Contains notification related data.
func (GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter)MarshalJSON¶added inv0.75.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility¶added inv0.41.0
type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility struct {// Eligibilities: 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.Eligibilities map[string]GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility `json:"eligibilities,omitempty"`// ForceSendFields is a list of field names (e.g. "Eligibilities") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Eligibilities") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility:PerSliSloEligibility is a mapping from an SLI name to eligibility.
func (GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility)MarshalJSON¶added inv0.41.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource¶added inv0.4.0
type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource struct {// ResourceType: 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'.ResourceTypestring `json:"resourceType,omitempty"`// ResourceUrl: URL identifying the resource, e.g.// "https://www.googleapis.com/compute/v1/projects/...)".ResourceUrlstring `json:"resourceUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "ResourceType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResourceType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource:Describes provisioned dataplane resources.
func (GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource)MarshalJSON¶added inv0.4.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1SloEligibility¶added inv0.16.0
type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility struct {// Eligible: Whether an instance is eligible or ineligible.Eligiblebool `json:"eligible,omitempty"`// Reason: 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.Reasonstring `json:"reason,omitempty"`// ForceSendFields is a list of field names (e.g. "Eligible") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Eligible") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility:SloEligibility is a tuple containing eligibility value: true if an instanceis eligible for SLO calculation or false if it should be excluded from allSLO-related calculations along with a user-defined reason.
func (GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility)MarshalJSON¶added inv0.16.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1SloEligibility) MarshalJSON() ([]byte,error)
typeGoogleCloudSaasacceleratorManagementProvidersV1SloMetadata¶added inv0.4.0
type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata struct {// Nodes: 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.Nodes []*GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata `json:"nodes,omitempty"`// PerSliEligibility: Optional. Multiple per-instance SLI eligibilities which// apply for individual SLIs.PerSliEligibility *GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility `json:"perSliEligibility,omitempty"`// Tier: 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.Tierstring `json:"tier,omitempty"`// ForceSendFields is a list of field names (e.g. "Nodes") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Nodes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata: SloMetadatacontains resources required for proper SLO classification of the instance.
func (GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata)MarshalJSON¶added inv0.4.0
func (sGoogleCloudSaasacceleratorManagementProvidersV1SloMetadata) MarshalJSON() ([]byte,error)
typeIOPSPerTB¶added inv0.197.0
type IOPSPerTB struct {// MaxIopsPerTb: Required. Maximum IOPS per TiB.MaxIopsPerTbint64 `json:"maxIopsPerTb,omitempty,string"`// ForceSendFields is a list of field names (e.g. "MaxIopsPerTb") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxIopsPerTb") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}IOPSPerTB: IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).
func (IOPSPerTB)MarshalJSON¶added inv0.197.0
typeInstance¶
type Instance struct {// CapacityStepSizeGb: Output only. The increase/decrease capacity step size in// GB.CapacityStepSizeGbint64 `json:"capacityStepSizeGb,omitempty,string"`// CreateTime: Output only. The time when the instance was created.CreateTimestring `json:"createTime,omitempty"`// CustomPerformanceSupported: Output only. Indicates whether this instance// supports configuring its performance. If true, the user can configure the// instance's performance by using the 'performance_config' field.CustomPerformanceSupportedbool `json:"customPerformanceSupported,omitempty"`// DeletionProtectionEnabled: Optional. Indicates whether the instance is// protected against deletion.DeletionProtectionEnabledbool `json:"deletionProtectionEnabled,omitempty"`// DeletionProtectionReason: Optional. The reason for enabling deletion// protection.DeletionProtectionReasonstring `json:"deletionProtectionReason,omitempty"`// Description: The description of the instance (2048 characters or less).Descriptionstring `json:"description,omitempty"`// DirectoryServices: Optional. Directory Services configuration for// Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1".DirectoryServices *DirectoryServicesConfig `json:"directoryServices,omitempty"`// Etag: Server-specified ETag for the instance resource to prevent// simultaneous updates from overwriting each other.Etagstring `json:"etag,omitempty"`// FileShares: File system shares on the instance. For this version, only a// single file share is supported.FileShares []*FileShareConfig `json:"fileShares,omitempty"`// KmsKeyName: KMS key name used for data encryption.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// Labels: Resource labels to represent user provided metadata.Labels map[string]string `json:"labels,omitempty"`// MaxCapacityGb: Output only. The max capacity of the instance in GB.MaxCapacityGbint64 `json:"maxCapacityGb,omitempty,string"`// MinCapacityGb: Output only. The min capacity of the instance in GB.MinCapacityGbint64 `json:"minCapacityGb,omitempty,string"`// Name: Output only. The resource name of the instance, in the format// `projects/{project}/locations/{location}/instances/{instance}`.Namestring `json:"name,omitempty"`// Networks: VPC networks to which the instance is connected. For this version,// only a single network is supported.Networks []*NetworkConfig `json:"networks,omitempty"`// PerformanceConfig: Optional. Used to configure performance.PerformanceConfig *PerformanceConfig `json:"performanceConfig,omitempty"`// PerformanceLimits: Output only. Used for getting performance limits.PerformanceLimits *PerformanceLimits `json:"performanceLimits,omitempty"`// Protocol: Immutable. The protocol indicates the access protocol for all// shares in the instance. This field is immutable and it cannot be changed// after the instance has been created. Default value: `NFS_V3`.//// Possible values:// "FILE_PROTOCOL_UNSPECIFIED" - FILE_PROTOCOL_UNSPECIFIED serves a "not set"// default value when a FileProtocol is a separate field in a message.// "NFS_V3" - NFS 3.0.// "NFS_V4_1" - NFS 4.1.Protocolstring `json:"protocol,omitempty"`// Replication: Optional. Replication configuration.Replication *Replication `json:"replication,omitempty"`// SatisfiesPzi: Output only. Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// State: Output only. The instance state.//// Possible values:// "STATE_UNSPECIFIED" - State not set.// "CREATING" - The instance is being created.// "READY" - The instance is available for use.// "REPAIRING" - Work is being done on the instance. You can get further// details from the `statusMessage` field of the `Instance` resource.// "DELETING" - The instance is shutting down.// "ERROR" - The instance is experiencing an issue and might be unusable. You// can get further details from the `statusMessage` field of the `Instance`// resource.// "RESTORING" - The instance is restoring a backup to an existing file share// and may be unusable during this time.// "SUSPENDED" - The instance is suspended. You can get further details from// the `suspension_reasons` field of the `Instance` resource.// "SUSPENDING" - The instance is in the process of becoming suspended.// "RESUMING" - The instance is in the process of becoming active.// "REVERTING" - The instance is reverting to a snapshot.// "PROMOTING" - The replica instance is being promoted.Statestring `json:"state,omitempty"`// StatusMessage: Output only. Additional information about the instance state,// if available.StatusMessagestring `json:"statusMessage,omitempty"`// SuspensionReasons: Output only. Field indicates all the reasons the instance// is in "SUSPENDED" state.//// Possible values:// "SUSPENSION_REASON_UNSPECIFIED" - Not set.// "KMS_KEY_ISSUE" - The KMS key used by the instance is either revoked or// denied access to.SuspensionReasons []string `json:"suspensionReasons,omitempty"`// Tags: Optional. Input only. Immutable. Tag key-value pairs bound to this// resource. Each key must be a namespaced name and each value a short name.// Example: "123456789012/environment" : "production",// "123456789013/costCenter" : "marketing" See the documentation for more// information: - Namespaced name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key// - Short name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_valueTags map[string]string `json:"tags,omitempty"`// Tier: The service tier of the instance.//// Possible values:// "TIER_UNSPECIFIED" - Not set.// "STANDARD" - STANDARD tier. BASIC_HDD is the preferred term for this tier.// "PREMIUM" - PREMIUM tier. BASIC_SSD is the preferred term for this tier.// "BASIC_HDD" - BASIC instances offer a maximum capacity of 63.9 TB.// BASIC_HDD is an alias for STANDARD Tier, offering economical performance// backed by HDD.// "BASIC_SSD" - BASIC instances offer a maximum capacity of 63.9 TB.// BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance// backed by SSD.// "HIGH_SCALE_SSD" - HIGH_SCALE instances offer expanded capacity and// performance scaling capabilities.// "ENTERPRISE" - ENTERPRISE instances offer the features and availability// needed for mission-critical workloads.// "ZONAL" - ZONAL instances offer expanded capacity and performance scaling// capabilities.// "REGIONAL" - REGIONAL instances offer the features and availability needed// for mission-critical workloads.Tierstring `json:"tier,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CapacityStepSizeGb") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CapacityStepSizeGb") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Instance: A Filestore instance.
func (Instance)MarshalJSON¶
typeLdapConfig¶added inv0.254.0
type LdapConfig struct {// Domain: Required. The LDAP domain name in the format of `my-domain.com`.Domainstring `json:"domain,omitempty"`// GroupsOu: Optional. The groups Organizational Unit (OU) is optional. This// parameter is a hint to allow faster lookup in the LDAP namespace. In case// that this parameter is not provided, Filestore instance will query the whole// LDAP namespace.GroupsOustring `json:"groupsOu,omitempty"`// Servers: Required. The servers names are used for specifying the LDAP// servers names. The LDAP servers names can come with two formats: 1. DNS// name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address,// for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be// in the same format: either all DNS names or all IP addresses.Servers []string `json:"servers,omitempty"`// UsersOu: Optional. The users Organizational Unit (OU) is optional. This// parameter is a hint to allow faster lookup in the LDAP namespace. In case// that this parameter is not provided, Filestore instance will query the whole// LDAP namespace.UsersOustring `json:"usersOu,omitempty"`// ForceSendFields is a list of field names (e.g. "Domain") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Domain") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}LdapConfig: LdapConfig contains all the parameters for connecting to LDAPservers.
func (LdapConfig)MarshalJSON¶added inv0.254.0
func (sLdapConfig) MarshalJSON() ([]byte,error)
typeListBackupsResponse¶added inv0.35.0
type ListBackupsResponse struct {// Backups: 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.Backups []*Backup `json:"backups,omitempty"`// NextPageToken: The token you can use to retrieve the next page of results.// Not returned if there are no more results in the list.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Unordered list. Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Backups") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Backups") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListBackupsResponse: ListBackupsResponse is the result ofListBackupsRequest.
func (ListBackupsResponse)MarshalJSON¶added inv0.35.0
func (sListBackupsResponse) MarshalJSON() ([]byte,error)
typeListInstancesResponse¶
type ListInstancesResponse struct {// Instances: 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.Instances []*Instance `json:"instances,omitempty"`// NextPageToken: The token you can use to retrieve the next page of results.// Not returned if there are no more results in the list.NextPageTokenstring `json:"nextPageToken,omitempty"`// Unreachable: Unordered list. Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Instances") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Instances") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListInstancesResponse: ListInstancesResponse is the result ofListInstancesRequest.
func (ListInstancesResponse)MarshalJSON¶
func (sListInstancesResponse) MarshalJSON() ([]byte,error)
typeListLocationsResponse¶
type ListLocationsResponse struct {// Locations: A list of locations that matches the specified filter in the// request.Locations []*Location `json:"locations,omitempty"`// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Locations") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Locations") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListLocationsResponse: The response message for Locations.ListLocations.
func (ListLocationsResponse)MarshalJSON¶
func (sListLocationsResponse) MarshalJSON() ([]byte,error)
typeListOperationsResponse¶
type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListOperationsResponse: The response message for Operations.ListOperations.
func (ListOperationsResponse)MarshalJSON¶
func (sListOperationsResponse) MarshalJSON() ([]byte,error)
typeListSnapshotsResponse¶added inv0.61.0
type ListSnapshotsResponse struct {// NextPageToken: The token you can use to retrieve the next page of results.// Not returned if there are no more results in the list.NextPageTokenstring `json:"nextPageToken,omitempty"`// Snapshots: A list of snapshots in the project for the specified instance.Snapshots []*Snapshot `json:"snapshots,omitempty"`// Unreachable: Unordered list. Locations that could not be reached.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListSnapshotsResponse: ListSnapshotsResponse is the result ofListSnapshotsRequest.
func (ListSnapshotsResponse)MarshalJSON¶added inv0.61.0
func (sListSnapshotsResponse) MarshalJSON() ([]byte,error)
typeLocation¶
type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// Labels: Cross-service attributes for the location. For example// {"cloud.googleapis.com/region": "us-east1"}Labels map[string]string `json:"labels,omitempty"`// LocationId: The canonical id for this location. For example: "us-east1".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Location: A resource that represents a Google Cloud location.
func (Location)MarshalJSON¶
typeMaintenancePolicy¶added inv0.35.0
type MaintenancePolicy struct {// CreateTime: Output only. The time when the resource was created.CreateTimestring `json:"createTime,omitempty"`// Description: Optional. Description of what this policy is for. Create/Update// methods return INVALID_ARGUMENT if the length is greater than 512.Descriptionstring `json:"description,omitempty"`// Labels: 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.Labels map[string]string `json:"labels,omitempty"`// Name: Required. MaintenancePolicy name using the form:// `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenan// ce_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])?`.Namestring `json:"name,omitempty"`// State: Optional. The state of the policy.//// Possible values:// "STATE_UNSPECIFIED" - Unspecified state.// "READY" - Resource is ready to be used.// "DELETING" - Resource is being deleted. It can no longer be attached to// instances.Statestring `json:"state,omitempty"`// UpdatePolicy: Maintenance policy applicable to instance update.UpdatePolicy *UpdatePolicy `json:"updatePolicy,omitempty"`// UpdateTime: Output only. The time when the resource was updated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MaintenancePolicy: Defines policies to service maintenance events.
func (MaintenancePolicy)MarshalJSON¶added inv0.35.0
func (sMaintenancePolicy) MarshalJSON() ([]byte,error)
typeMaintenanceWindow¶added inv0.35.0
type MaintenanceWindow struct {// DailyCycle: Daily cycle.DailyCycle *DailyCycle `json:"dailyCycle,omitempty"`// WeeklyCycle: Weekly cycle.WeeklyCycle *WeeklyCycle `json:"weeklyCycle,omitempty"`// ForceSendFields is a list of field names (e.g. "DailyCycle") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DailyCycle") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MaintenanceWindow: MaintenanceWindow definition.
func (MaintenanceWindow)MarshalJSON¶added inv0.35.0
func (sMaintenanceWindow) MarshalJSON() ([]byte,error)
typeNetworkConfig¶
type NetworkConfig struct {// ConnectMode: The network connect mode of the Filestore instance. If not// provided, the connect mode defaults to DIRECT_PEERING.//// Possible values:// "CONNECT_MODE_UNSPECIFIED" - Not set.// "DIRECT_PEERING" - Connect via direct peering to the Filestore service.// "PRIVATE_SERVICE_ACCESS" - Connect to your Filestore instance using// Private Service Access. Private services access provides an IP address range// for multiple Google Cloud services, including Filestore.// "PRIVATE_SERVICE_CONNECT" - Connect to your Filestore instance using// Private Service Connect. A connection policy must exist in the region for// the VPC network and the google-cloud-filestore service class.ConnectModestring `json:"connectMode,omitempty"`// IpAddresses: Output only. IPv4 addresses in the format// `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format// `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.IpAddresses []string `json:"ipAddresses,omitempty"`// Modes: Internet protocol versions for which the instance has IP addresses// assigned. For this version, only MODE_IPV4 is supported.//// Possible values:// "ADDRESS_MODE_UNSPECIFIED" - Internet protocol not set.// "MODE_IPV4" - Use the IPv4 internet protocol.Modes []string `json:"modes,omitempty"`// Network: The name of the Google Compute Engine VPC network// (https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.Networkstring `json:"network,omitempty"`// PscConfig: Optional. Private Service Connect configuration. Should only be// set when connect_mode is PRIVATE_SERVICE_CONNECT.PscConfig *PscConfig `json:"pscConfig,omitempty"`// ReservedIpRange: Optional, reserved_ip_range can have one of the following// two types of values. * CIDR range value when using DIRECT_PEERING connect// mode. * Allocated IP address range// (https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address)// when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an// allocated IP address range is specified, it must be one of the ranges// associated with the private service access connection. When specified as a// direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR// block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of// the internal IP address ranges// (https://www.arin.net/reference/research/statistics/address_filters/) that// identifies the range of IP addresses reserved for this instance. For// example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The// range you specify can't overlap with either existing subnets or assigned IP// address ranges for other Filestore instances in the selected VPC network.ReservedIpRangestring `json:"reservedIpRange,omitempty"`// ForceSendFields is a list of field names (e.g. "ConnectMode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConnectMode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}NetworkConfig: Network configuration for the instance.
func (NetworkConfig)MarshalJSON¶
func (sNetworkConfig) MarshalJSON() ([]byte,error)
typeNfsExportOptions¶added inv0.37.0
type NfsExportOptions struct {// AccessMode: 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.//// Possible values:// "ACCESS_MODE_UNSPECIFIED" - AccessMode not set.// "READ_ONLY" - The client can only read the file share.// "READ_WRITE" - The client can read and write the file share (default).AccessModestring `json:"accessMode,omitempty"`// AnonGid: 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.AnonGidint64 `json:"anonGid,omitempty,string"`// AnonUid: 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.AnonUidint64 `json:"anonUid,omitempty,string"`// IpRanges: List of either an IPv4 addresses in the format// `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format// `{octet1}.{octet2}.{octet3}.{octet4}/{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.IpRanges []string `json:"ipRanges,omitempty"`// Network: Optional. The source VPC network for ip_ranges. Required for// instances using Private Service Connect, optional otherwise. If provided,// must be the same network specified in the `NetworkConfig.network` field.Networkstring `json:"network,omitempty"`// SquashMode: 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.//// Possible values:// "SQUASH_MODE_UNSPECIFIED" - SquashMode not set.// "NO_ROOT_SQUASH" - The Root user has root access to the file share// (default).// "ROOT_SQUASH" - The Root user has squashed access to the anonymous// uid/gid.SquashModestring `json:"squashMode,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessMode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessMode") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}NfsExportOptions: NFS export options specifications.
func (NfsExportOptions)MarshalJSON¶added inv0.37.0
func (sNfsExportOptions) MarshalJSON() ([]byte,error)
typeOperation¶
type Operation struct {// Done: 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.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: 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.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: 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}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Operation: This resource represents a long-running operation that is theresult of a network API call.
func (Operation)MarshalJSON¶
typeOperationMetadata¶
type OperationMetadata struct {// ApiVersion: Output only. API version used to start the operation.ApiVersionstring `json:"apiVersion,omitempty"`// CancelRequested: Output only. Identifies whether the user has requested// cancellation of the operation. Operations that have been cancelled// successfully have google.longrunning.Operation.error value with a// google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.CancelRequestedbool `json:"cancelRequested,omitempty"`// CreateTime: Output only. The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// EndTime: Output only. The time the operation finished running.EndTimestring `json:"endTime,omitempty"`// StatusDetail: Output only. Human-readable status of the operation, if any.StatusDetailstring `json:"statusDetail,omitempty"`// Target: Output only. Server-defined resource path for the target of the// operation.Targetstring `json:"target,omitempty"`// Verb: Output only. Name of the verb executed by the operation.Verbstring `json:"verb,omitempty"`// ForceSendFields is a list of field names (e.g. "ApiVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ApiVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}OperationMetadata: Represents the metadata of the long-running operation.
func (OperationMetadata)MarshalJSON¶
func (sOperationMetadata) MarshalJSON() ([]byte,error)
typePerformanceConfig¶added inv0.187.0
type PerformanceConfig struct {// FixedIops: Choose a fixed provisioned IOPS value for the instance, which// will remain constant regardless of instance capacity. Value must be a// multiple of 1000. If the chosen value is outside the supported range for the// instance's capacity during instance creation, instance creation will fail// with an `InvalidArgument` error. Similarly, if an instance capacity update// would result in a value outside the supported range, the update will fail// with an `InvalidArgument` error.FixedIops *FixedIOPS `json:"fixedIops,omitempty"`// IopsPerTb: Provision IOPS dynamically based on the capacity of the instance.// Provisioned IOPS will be calculated by multiplying the capacity of the// instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB// instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be// 34000. If the calculated value is outside the supported range for the// instance's capacity during instance creation, instance creation will fail// with an `InvalidArgument` error. Similarly, if an instance capacity update// would result in a value outside the supported range, the update will fail// with an `InvalidArgument` error.IopsPerTb *IOPSPerTB `json:"iopsPerTb,omitempty"`// ForceSendFields is a list of field names (e.g. "FixedIops") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FixedIops") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PerformanceConfig: Used for setting the performance configuration. If theuser doesn't specify PerformanceConfig, automatically provision the defaultperformance settings as described inhttps://cloud.google.com/filestore/docs/performance. Larger instances willbe linearly set to more IOPS. If the instance's capacity is increased ordecreased, its performance will be automatically adjusted upwards ordownwards accordingly (respectively).
func (PerformanceConfig)MarshalJSON¶added inv0.187.0
func (sPerformanceConfig) MarshalJSON() ([]byte,error)
typePerformanceLimits¶added inv0.187.0
type PerformanceLimits struct {// MaxIops: Output only. The max IOPS.MaxIopsint64 `json:"maxIops,omitempty,string"`// MaxReadIops: Output only. The max read IOPS.MaxReadIopsint64 `json:"maxReadIops,omitempty,string"`// MaxReadThroughputBps: Output only. The max read throughput in bytes per// second.MaxReadThroughputBpsint64 `json:"maxReadThroughputBps,omitempty,string"`// MaxWriteIops: Output only. The max write IOPS.MaxWriteIopsint64 `json:"maxWriteIops,omitempty,string"`// MaxWriteThroughputBps: Output only. The max write throughput in bytes per// second.MaxWriteThroughputBpsint64 `json:"maxWriteThroughputBps,omitempty,string"`// ForceSendFields is a list of field names (e.g. "MaxIops") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxIops") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PerformanceLimits: The enforced performance limits, calculated from theinstance's performance configuration.
func (PerformanceLimits)MarshalJSON¶added inv0.187.0
func (sPerformanceLimits) MarshalJSON() ([]byte,error)
typeProjectsLocationsBackupsCreateCall¶added inv0.35.0
type ProjectsLocationsBackupsCreateCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsBackupsCreateCall)BackupId¶added inv0.35.0
func (c *ProjectsLocationsBackupsCreateCall) BackupId(backupIdstring) *ProjectsLocationsBackupsCreateCall
BackupId sets the optional parameter "backupId": Required. The ID to use forthe 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 lowercaseletters, numbers, or hyphens, and cannot end with a hyphen. Values that donot match this pattern will trigger an INVALID_ARGUMENT error.
func (*ProjectsLocationsBackupsCreateCall)Context¶added inv0.35.0
func (c *ProjectsLocationsBackupsCreateCall) Context(ctxcontext.Context) *ProjectsLocationsBackupsCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsBackupsCreateCall)Do¶added inv0.35.0
func (c *ProjectsLocationsBackupsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.backups.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsBackupsCreateCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsBackupsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsBackupsCreateCall)Header¶added inv0.35.0
func (c *ProjectsLocationsBackupsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsBackupsDeleteCall¶added inv0.35.0
type ProjectsLocationsBackupsDeleteCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsBackupsDeleteCall)Context¶added inv0.35.0
func (c *ProjectsLocationsBackupsDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsBackupsDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsBackupsDeleteCall)Do¶added inv0.35.0
func (c *ProjectsLocationsBackupsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.backups.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsBackupsDeleteCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsBackupsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsBackupsDeleteCall)Header¶added inv0.35.0
func (c *ProjectsLocationsBackupsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsBackupsGetCall¶added inv0.35.0
type ProjectsLocationsBackupsGetCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsBackupsGetCall)Context¶added inv0.35.0
func (c *ProjectsLocationsBackupsGetCall) Context(ctxcontext.Context) *ProjectsLocationsBackupsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsBackupsGetCall)Do¶added inv0.35.0
func (c *ProjectsLocationsBackupsGetCall) Do(opts ...googleapi.CallOption) (*Backup,error)
Do executes the "file.projects.locations.backups.get" call.Any non-2xx status code is an error. Response headers are in either*Backup.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsBackupsGetCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsBackupsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsBackupsGetCall)Header¶added inv0.35.0
func (c *ProjectsLocationsBackupsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsBackupsGetCall)IfNoneMatch¶added inv0.35.0
func (c *ProjectsLocationsBackupsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsBackupsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsLocationsBackupsListCall¶added inv0.35.0
type ProjectsLocationsBackupsListCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsBackupsListCall)Context¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Context(ctxcontext.Context) *ProjectsLocationsBackupsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsBackupsListCall)Do¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Do(opts ...googleapi.CallOption) (*ListBackupsResponse,error)
Do executes the "file.projects.locations.backups.list" call.Any non-2xx status code is an error. Response headers are in either*ListBackupsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsBackupsListCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsBackupsListCall)Filter¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Filter(filterstring) *ProjectsLocationsBackupsListCall
Filter sets the optional parameter "filter": List filter.
func (*ProjectsLocationsBackupsListCall)Header¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsBackupsListCall)IfNoneMatch¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsBackupsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsLocationsBackupsListCall)OrderBy¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) OrderBy(orderBystring) *ProjectsLocationsBackupsListCall
OrderBy sets the optional parameter "orderBy": Sort results. Supportedvalues are "name", "name desc" or "" (unsorted).
func (*ProjectsLocationsBackupsListCall)PageSize¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) PageSize(pageSizeint64) *ProjectsLocationsBackupsListCall
PageSize sets the optional parameter "pageSize": The maximum number of itemsto return.
func (*ProjectsLocationsBackupsListCall)PageToken¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) PageToken(pageTokenstring) *ProjectsLocationsBackupsListCall
PageToken sets the optional parameter "pageToken": The next_page_token valueto use if there are additional results to retrieve for this list request.
func (*ProjectsLocationsBackupsListCall)Pages¶added inv0.35.0
func (c *ProjectsLocationsBackupsListCall) Pages(ctxcontext.Context, f func(*ListBackupsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeProjectsLocationsBackupsPatchCall¶added inv0.35.0
type ProjectsLocationsBackupsPatchCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsBackupsPatchCall)Context¶added inv0.35.0
func (c *ProjectsLocationsBackupsPatchCall) Context(ctxcontext.Context) *ProjectsLocationsBackupsPatchCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsBackupsPatchCall)Do¶added inv0.35.0
func (c *ProjectsLocationsBackupsPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.backups.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsBackupsPatchCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsBackupsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsBackupsPatchCall)Header¶added inv0.35.0
func (c *ProjectsLocationsBackupsPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsBackupsPatchCall)UpdateMask¶added inv0.35.0
func (c *ProjectsLocationsBackupsPatchCall) UpdateMask(updateMaskstring) *ProjectsLocationsBackupsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Mask offields to update. At least one path must be supplied in this field.
typeProjectsLocationsBackupsService¶added inv0.35.0
type ProjectsLocationsBackupsService struct {// contains filtered or unexported fields}funcNewProjectsLocationsBackupsService¶added inv0.35.0
func NewProjectsLocationsBackupsService(s *Service) *ProjectsLocationsBackupsService
func (*ProjectsLocationsBackupsService)Create¶added inv0.35.0
func (r *ProjectsLocationsBackupsService) Create(parentstring, backup *Backup) *ProjectsLocationsBackupsCreateCall
Create: Creates a backup.
- parent: The backup's project and location, in the format`projects/{project_number}/locations/{location}`. In Filestore, backuplocations map to Google Cloud regions, for example **us-west1**.
func (*ProjectsLocationsBackupsService)Delete¶added inv0.35.0
func (r *ProjectsLocationsBackupsService) Delete(namestring) *ProjectsLocationsBackupsDeleteCall
Delete: Deletes a backup.
- name: The backup resource name, in the format`projects/{project_number}/locations/{location}/backups/{backup_id}`.
func (*ProjectsLocationsBackupsService)Get¶added inv0.35.0
func (r *ProjectsLocationsBackupsService) Get(namestring) *ProjectsLocationsBackupsGetCall
Get: Gets the details of a specific backup.
- name: The backup resource name, in the format`projects/{project_number}/locations/{location}/backups/{backup_id}`.
func (*ProjectsLocationsBackupsService)List¶added inv0.35.0
func (r *ProjectsLocationsBackupsService) List(parentstring) *ProjectsLocationsBackupsListCall
List: Lists all backups in a project for either a specified location or forall locations.
- parent: The project and location for which to retrieve backup information,in the format `projects/{project_number}/locations/{location}`. InFilestore, backup locations map to Google Cloud regions, for example**us-west1**. To retrieve backup information for all locations, use "-"for the `{location}` value.
func (*ProjectsLocationsBackupsService)Patch¶added inv0.35.0
func (r *ProjectsLocationsBackupsService) Patch(namestring, backup *Backup) *ProjectsLocationsBackupsPatchCall
Patch: Updates the settings of a specific backup.
- name: Output only. The resource name of the backup, in the format`projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
typeProjectsLocationsGetCall¶
type ProjectsLocationsGetCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsGetCall)Context¶
func (c *ProjectsLocationsGetCall) Context(ctxcontext.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsGetCall)Do¶
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location,error)
Do executes the "file.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsGetCall)Fields¶
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsGetCall)Header¶
func (c *ProjectsLocationsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsGetCall)IfNoneMatch¶
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsLocationsInstancesCreateCall¶
type ProjectsLocationsInstancesCreateCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesCreateCall)Context¶
func (c *ProjectsLocationsInstancesCreateCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesCreateCall)Do¶
func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesCreateCall)Fields¶
func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesCreateCall)Header¶
func (c *ProjectsLocationsInstancesCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesCreateCall)InstanceId¶
func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceIdstring) *ProjectsLocationsInstancesCreateCall
InstanceId sets the optional parameter "instanceId": Required. The name ofthe instance to create. The name must be unique for the specified projectand location.
typeProjectsLocationsInstancesDeleteCall¶
type ProjectsLocationsInstancesDeleteCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesDeleteCall)Context¶
func (c *ProjectsLocationsInstancesDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesDeleteCall)Do¶
func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesDeleteCall)Fields¶
func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesDeleteCall)Force¶added inv0.61.0
func (c *ProjectsLocationsInstancesDeleteCall) Force(forcebool) *ProjectsLocationsInstancesDeleteCall
Force sets the optional parameter "force": If set to true, all snapshots ofthe instance will also be deleted. (Otherwise, the request will only work ifthe instance has no snapshots.)
func (*ProjectsLocationsInstancesDeleteCall)Header¶
func (c *ProjectsLocationsInstancesDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsInstancesGetCall¶
type ProjectsLocationsInstancesGetCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesGetCall)Context¶
func (c *ProjectsLocationsInstancesGetCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesGetCall)Do¶
func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance,error)
Do executes the "file.projects.locations.instances.get" call.Any non-2xx status code is an error. Response headers are in either*Instance.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesGetCall)Fields¶
func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesGetCall)Header¶
func (c *ProjectsLocationsInstancesGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesGetCall)IfNoneMatch¶
func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsInstancesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsLocationsInstancesListCall¶
type ProjectsLocationsInstancesListCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesListCall)Context¶
func (c *ProjectsLocationsInstancesListCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesListCall)Do¶
func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse,error)
Do executes the "file.projects.locations.instances.list" call.Any non-2xx status code is an error. Response headers are in either*ListInstancesResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsInstancesListCall)Fields¶
func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesListCall)Filter¶
func (c *ProjectsLocationsInstancesListCall) Filter(filterstring) *ProjectsLocationsInstancesListCall
Filter sets the optional parameter "filter": List filter.
func (*ProjectsLocationsInstancesListCall)Header¶
func (c *ProjectsLocationsInstancesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesListCall)IfNoneMatch¶
func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsInstancesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsLocationsInstancesListCall)OrderBy¶
func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBystring) *ProjectsLocationsInstancesListCall
OrderBy sets the optional parameter "orderBy": Sort results. Supportedvalues are "name", "name desc" or "" (unsorted).
func (*ProjectsLocationsInstancesListCall)PageSize¶
func (c *ProjectsLocationsInstancesListCall) PageSize(pageSizeint64) *ProjectsLocationsInstancesListCall
PageSize sets the optional parameter "pageSize": The maximum number of itemsto return.
func (*ProjectsLocationsInstancesListCall)PageToken¶
func (c *ProjectsLocationsInstancesListCall) PageToken(pageTokenstring) *ProjectsLocationsInstancesListCall
PageToken sets the optional parameter "pageToken": The next_page_token valueto use if there are additional results to retrieve for this list request.
func (*ProjectsLocationsInstancesListCall)Pages¶
func (c *ProjectsLocationsInstancesListCall) Pages(ctxcontext.Context, f func(*ListInstancesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeProjectsLocationsInstancesPatchCall¶
type ProjectsLocationsInstancesPatchCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesPatchCall)Context¶
func (c *ProjectsLocationsInstancesPatchCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesPatchCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesPatchCall)Do¶
func (c *ProjectsLocationsInstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesPatchCall)Fields¶
func (c *ProjectsLocationsInstancesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesPatchCall)Header¶
func (c *ProjectsLocationsInstancesPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesPatchCall)UpdateMask¶
func (c *ProjectsLocationsInstancesPatchCall) UpdateMask(updateMaskstring) *ProjectsLocationsInstancesPatchCall
UpdateMask sets the optional parameter "updateMask": Mask of fields toupdate. At least one path must be supplied in this field. The elements ofthe repeated paths field may only include these fields: * "description" *"file_shares" * "labels" * "performance_config" *"deletion_protection_enabled" * "deletion_protection_reason"
typeProjectsLocationsInstancesPromoteReplicaCall¶added inv0.186.0
type ProjectsLocationsInstancesPromoteReplicaCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesPromoteReplicaCall)Context¶added inv0.186.0
func (c *ProjectsLocationsInstancesPromoteReplicaCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesPromoteReplicaCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesPromoteReplicaCall)Do¶added inv0.186.0
func (c *ProjectsLocationsInstancesPromoteReplicaCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.promoteReplica" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesPromoteReplicaCall)Fields¶added inv0.186.0
func (c *ProjectsLocationsInstancesPromoteReplicaCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPromoteReplicaCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesPromoteReplicaCall)Header¶added inv0.186.0
func (c *ProjectsLocationsInstancesPromoteReplicaCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsInstancesRestoreCall¶added inv0.35.0
type ProjectsLocationsInstancesRestoreCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesRestoreCall)Context¶added inv0.35.0
func (c *ProjectsLocationsInstancesRestoreCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesRestoreCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesRestoreCall)Do¶added inv0.35.0
func (c *ProjectsLocationsInstancesRestoreCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.restore" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesRestoreCall)Fields¶added inv0.35.0
func (c *ProjectsLocationsInstancesRestoreCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRestoreCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesRestoreCall)Header¶added inv0.35.0
func (c *ProjectsLocationsInstancesRestoreCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsInstancesRevertCall¶added inv0.119.0
type ProjectsLocationsInstancesRevertCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesRevertCall)Context¶added inv0.119.0
func (c *ProjectsLocationsInstancesRevertCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesRevertCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesRevertCall)Do¶added inv0.119.0
func (c *ProjectsLocationsInstancesRevertCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.revert" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesRevertCall)Fields¶added inv0.119.0
func (c *ProjectsLocationsInstancesRevertCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRevertCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesRevertCall)Header¶added inv0.119.0
func (c *ProjectsLocationsInstancesRevertCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsInstancesService¶
type ProjectsLocationsInstancesService struct {Snapshots *ProjectsLocationsInstancesSnapshotsService// contains filtered or unexported fields}funcNewProjectsLocationsInstancesService¶
func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService
func (*ProjectsLocationsInstancesService)Create¶
func (r *ProjectsLocationsInstancesService) Create(parentstring, instance *Instance) *ProjectsLocationsInstancesCreateCall
Create: Creates an instance. When creating from a backup, the capacity ofthe new instance needs to be equal to or larger than the capacity of thebackup (and also equal to or larger than the minimum capacity of the tier).
- parent: The instance's project and location, in the format`projects/{project_id}/locations/{location}`. In Filestore, locations mapto Google Cloud zones, for example **us-west1-b**.
func (*ProjectsLocationsInstancesService)Delete¶
func (r *ProjectsLocationsInstancesService) Delete(namestring) *ProjectsLocationsInstancesDeleteCall
Delete: Deletes an instance.
- name: The instance resource name, in the format`projects/{project_id}/locations/{location}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesService)Get¶
func (r *ProjectsLocationsInstancesService) Get(namestring) *ProjectsLocationsInstancesGetCall
Get: Gets the details of a specific instance.
- name: The instance resource name, in the format`projects/{project_id}/locations/{location}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesService)List¶
func (r *ProjectsLocationsInstancesService) List(parentstring) *ProjectsLocationsInstancesListCall
List: Lists all instances in a project for either a specified location orfor all locations.
- parent: The project and location for which to retrieve instanceinformation, 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.
func (*ProjectsLocationsInstancesService)Patch¶
func (r *ProjectsLocationsInstancesService) Patch(namestring, instance *Instance) *ProjectsLocationsInstancesPatchCall
Patch: Updates the settings of a specific instance.
- name: Output only. The resource name of the instance, in the format`projects/{project}/locations/{location}/instances/{instance}`.
func (*ProjectsLocationsInstancesService)PromoteReplica¶added inv0.186.0
func (r *ProjectsLocationsInstancesService) PromoteReplica(namestring, promotereplicarequest *PromoteReplicaRequest) *ProjectsLocationsInstancesPromoteReplicaCall
PromoteReplica: Promote the standby instance (replica).
- name: The resource name of the instance, in the format`projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesService)Restore¶added inv0.35.0
func (r *ProjectsLocationsInstancesService) Restore(namestring, restoreinstancerequest *RestoreInstanceRequest) *ProjectsLocationsInstancesRestoreCall
Restore: Restores an existing instance's file share from a backup. Thecapacity of the instance needs to be equal to or larger than the capacity ofthe backup (and also equal to or larger than the minimum capacity of thetier).
- name: The resource name of the instance, in the format`projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesService)Revert¶added inv0.119.0
func (r *ProjectsLocationsInstancesService) Revert(namestring, revertinstancerequest *RevertInstanceRequest) *ProjectsLocationsInstancesRevertCall
Revert: Revert an existing instance's file system to a specified snapshot.
- name: The resource name of the instance, in the format`projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
typeProjectsLocationsInstancesSnapshotsCreateCall¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsCreateCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesSnapshotsCreateCall)Context¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesSnapshotsCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesSnapshotsCreateCall)Do¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.snapshots.create" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesSnapshotsCreateCall)Fields¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesSnapshotsCreateCall)Header¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesSnapshotsCreateCall)SnapshotId¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsCreateCall) SnapshotId(snapshotIdstring) *ProjectsLocationsInstancesSnapshotsCreateCall
SnapshotId sets the optional parameter "snapshotId": Required. The ID to usefor the snapshot. The ID must be unique within the specified instance. Thisvalue must start with a lowercase letter followed by up to 62 lowercaseletters, numbers, or hyphens, and cannot end with a hyphen.
typeProjectsLocationsInstancesSnapshotsDeleteCall¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsDeleteCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesSnapshotsDeleteCall)Context¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesSnapshotsDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesSnapshotsDeleteCall)Do¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.snapshots.delete" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesSnapshotsDeleteCall)Fields¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesSnapshotsDeleteCall)Header¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsInstancesSnapshotsGetCall¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsGetCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesSnapshotsGetCall)Context¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsGetCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesSnapshotsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesSnapshotsGetCall)Do¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot,error)
Do executes the "file.projects.locations.instances.snapshots.get" call.Any non-2xx status code is an error. Response headers are in either*Snapshot.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesSnapshotsGetCall)Fields¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesSnapshotsGetCall)Header¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesSnapshotsGetCall)IfNoneMatch¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsInstancesSnapshotsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsLocationsInstancesSnapshotsListCall¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsListCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesSnapshotsListCall)Context¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesSnapshotsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesSnapshotsListCall)Do¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse,error)
Do executes the "file.projects.locations.instances.snapshots.list" call.Any non-2xx status code is an error. Response headers are in either*ListSnapshotsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsInstancesSnapshotsListCall)Fields¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesSnapshotsListCall)Filter¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Filter(filterstring) *ProjectsLocationsInstancesSnapshotsListCall
Filter sets the optional parameter "filter": List filter.
func (*ProjectsLocationsInstancesSnapshotsListCall)Header¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesSnapshotsListCall)IfNoneMatch¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsInstancesSnapshotsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsLocationsInstancesSnapshotsListCall)OrderBy¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) OrderBy(orderBystring) *ProjectsLocationsInstancesSnapshotsListCall
OrderBy sets the optional parameter "orderBy": Sort results. Supportedvalues are "name", "name desc" or "" (unsorted).
func (*ProjectsLocationsInstancesSnapshotsListCall)PageSize¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) PageSize(pageSizeint64) *ProjectsLocationsInstancesSnapshotsListCall
PageSize sets the optional parameter "pageSize": The maximum number of itemsto return.
func (*ProjectsLocationsInstancesSnapshotsListCall)PageToken¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) PageToken(pageTokenstring) *ProjectsLocationsInstancesSnapshotsListCall
PageToken sets the optional parameter "pageToken": The next_page_token valueto use if there are additional results to retrieve for this list request.
func (*ProjectsLocationsInstancesSnapshotsListCall)Pages¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) Pages(ctxcontext.Context, f func(*ListSnapshotsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*ProjectsLocationsInstancesSnapshotsListCall)ReturnPartialSuccess¶added inv0.212.0
func (c *ProjectsLocationsInstancesSnapshotsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsInstancesSnapshotsListCall
ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": Iftrue, allow partial responses for multi-regional Aggregated List requests.
typeProjectsLocationsInstancesSnapshotsPatchCall¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsPatchCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsInstancesSnapshotsPatchCall)Context¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Context(ctxcontext.Context) *ProjectsLocationsInstancesSnapshotsPatchCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesSnapshotsPatchCall)Do¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.instances.snapshots.patch" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsInstancesSnapshotsPatchCall)Fields¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsInstancesSnapshotsPatchCall)Header¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsInstancesSnapshotsPatchCall)UpdateMask¶added inv0.61.0
func (c *ProjectsLocationsInstancesSnapshotsPatchCall) UpdateMask(updateMaskstring) *ProjectsLocationsInstancesSnapshotsPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Mask offields to update. At least one path must be supplied in this field.
typeProjectsLocationsInstancesSnapshotsService¶added inv0.61.0
type ProjectsLocationsInstancesSnapshotsService struct {// contains filtered or unexported fields}funcNewProjectsLocationsInstancesSnapshotsService¶added inv0.61.0
func NewProjectsLocationsInstancesSnapshotsService(s *Service) *ProjectsLocationsInstancesSnapshotsService
func (*ProjectsLocationsInstancesSnapshotsService)Create¶added inv0.61.0
func (r *ProjectsLocationsInstancesSnapshotsService) Create(parentstring, snapshot *Snapshot) *ProjectsLocationsInstancesSnapshotsCreateCall
Create: Creates a snapshot.
- parent: The Filestore Instance to create the snapshots of, in the format`projects/{project_id}/locations/{location}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesSnapshotsService)Delete¶added inv0.61.0
func (r *ProjectsLocationsInstancesSnapshotsService) Delete(namestring) *ProjectsLocationsInstancesSnapshotsDeleteCall
Delete: Deletes a snapshot.
- name: The snapshot resource name, in the format`projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`.
func (*ProjectsLocationsInstancesSnapshotsService)Get¶added inv0.61.0
func (r *ProjectsLocationsInstancesSnapshotsService) Get(namestring) *ProjectsLocationsInstancesSnapshotsGetCall
Get: Gets the details of a specific snapshot.
- name: The snapshot resource name, in the format`projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`.
func (*ProjectsLocationsInstancesSnapshotsService)List¶added inv0.61.0
func (r *ProjectsLocationsInstancesSnapshotsService) List(parentstring) *ProjectsLocationsInstancesSnapshotsListCall
List: Lists all snapshots in a project for either a specified location orfor all locations.
- parent: The instance for which to retrieve snapshot information, in theformat`projects/{project_id}/locations/{location}/instances/{instance_id}`.
func (*ProjectsLocationsInstancesSnapshotsService)Patch¶added inv0.61.0
func (r *ProjectsLocationsInstancesSnapshotsService) Patch(namestring, snapshot *Snapshot) *ProjectsLocationsInstancesSnapshotsPatchCall
Patch: Updates the settings of a specific snapshot.
- name: Output only. The resource name of the snapshot, in the format`projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`.
typeProjectsLocationsListCall¶
type ProjectsLocationsListCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsListCall)Context¶
func (c *ProjectsLocationsListCall) Context(ctxcontext.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsListCall)Do¶
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse,error)
Do executes the "file.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsListCall)ExtraLocationTypes¶added inv0.229.0
func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall
ExtraLocationTypes sets the optional parameter "extraLocationTypes": Unlessexplicitly documented otherwise, don't use this unsupported field which isprimarily intended for internal usage.
func (*ProjectsLocationsListCall)Fields¶
func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsListCall)Filter¶
func (c *ProjectsLocationsListCall) Filter(filterstring) *ProjectsLocationsListCall
Filter sets the optional parameter "filter": A filter to narrow down resultsto 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).
func (*ProjectsLocationsListCall)Header¶
func (c *ProjectsLocationsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsListCall)IfNoneMatch¶
func (c *ProjectsLocationsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsLocationsListCall)PageSize¶
func (c *ProjectsLocationsListCall) PageSize(pageSizeint64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.
func (*ProjectsLocationsListCall)PageToken¶
func (c *ProjectsLocationsListCall) PageToken(pageTokenstring) *ProjectsLocationsListCall
PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.
func (*ProjectsLocationsListCall)Pages¶
func (c *ProjectsLocationsListCall) Pages(ctxcontext.Context, f func(*ListLocationsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeProjectsLocationsOperationsCancelCall¶
type ProjectsLocationsOperationsCancelCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsOperationsCancelCall)Context¶
func (c *ProjectsLocationsOperationsCancelCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsCancelCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsCancelCall)Do¶
func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "file.projects.locations.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsCancelCall)Fields¶
func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsOperationsCancelCall)Header¶
func (c *ProjectsLocationsOperationsCancelCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsOperationsDeleteCall¶
type ProjectsLocationsOperationsDeleteCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsOperationsDeleteCall)Context¶
func (c *ProjectsLocationsOperationsDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsDeleteCall)Do¶
func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty,error)
Do executes the "file.projects.locations.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsDeleteCall)Fields¶
func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsOperationsDeleteCall)Header¶
func (c *ProjectsLocationsOperationsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeProjectsLocationsOperationsGetCall¶
type ProjectsLocationsOperationsGetCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsOperationsGetCall)Context¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsGetCall)Do¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation,error)
Do executes the "file.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*ProjectsLocationsOperationsGetCall)Fields¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsOperationsGetCall)Header¶
func (c *ProjectsLocationsOperationsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsOperationsGetCall)IfNoneMatch¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsOperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeProjectsLocationsOperationsListCall¶
type ProjectsLocationsOperationsListCall struct {// contains filtered or unexported fields}func (*ProjectsLocationsOperationsListCall)Context¶
func (c *ProjectsLocationsOperationsListCall) Context(ctxcontext.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsListCall)Do¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse,error)
Do executes the "file.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*ProjectsLocationsOperationsListCall)Fields¶
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*ProjectsLocationsOperationsListCall)Filter¶
func (c *ProjectsLocationsOperationsListCall) Filter(filterstring) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall)Header¶
func (c *ProjectsLocationsOperationsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*ProjectsLocationsOperationsListCall)IfNoneMatch¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsOperationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*ProjectsLocationsOperationsListCall)PageSize¶
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSizeint64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list pagesize.
func (*ProjectsLocationsOperationsListCall)PageToken¶
func (c *ProjectsLocationsOperationsListCall) PageToken(pageTokenstring) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list pagetoken.
func (*ProjectsLocationsOperationsListCall)Pages¶
func (c *ProjectsLocationsOperationsListCall) Pages(ctxcontext.Context, f func(*ListOperationsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccess¶added inv0.254.0
func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall
ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.
typeProjectsLocationsOperationsService¶
type ProjectsLocationsOperationsService struct {// contains filtered or unexported fields}funcNewProjectsLocationsOperationsService¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService)Cancel¶
func (r *ProjectsLocationsOperationsService) Cancel(namestring, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.error value with a google.rpc.Status.code of `1`, corresponding to`Code.CANCELLED`.
- name: The name of the operation resource to be cancelled.
func (*ProjectsLocationsOperationsService)Delete¶
func (r *ProjectsLocationsOperationsService) Delete(namestring) *ProjectsLocationsOperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that theclient is no longer interested in the operation result. It does not cancelthe operation. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
func (*ProjectsLocationsOperationsService)Get¶
func (r *ProjectsLocationsOperationsService) Get(namestring) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService)List¶
func (r *ProjectsLocationsOperationsService) List(namestring) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.
- name: The name of the operation's parent resource.
typeProjectsLocationsService¶
type ProjectsLocationsService struct {Backups *ProjectsLocationsBackupsServiceInstances *ProjectsLocationsInstancesServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}funcNewProjectsLocationsService¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService)Get¶
func (r *ProjectsLocationsService) Get(namestring) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (*ProjectsLocationsService)List¶
func (r *ProjectsLocationsService) List(namestring) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
- name: The resource that owns the locations collection, if applicable.
typeProjectsService¶
type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}funcNewProjectsService¶
func NewProjectsService(s *Service) *ProjectsService
typePromoteReplicaRequest¶added inv0.186.0
type PromoteReplicaRequest struct {// PeerInstance: Optional. The resource name of the peer instance to promote,// in the format// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. The// peer instance is required if the operation is called on an active instance.PeerInstancestring `json:"peerInstance,omitempty"`// ForceSendFields is a list of field names (e.g. "PeerInstance") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PeerInstance") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PromoteReplicaRequest: PromoteReplicaRequest promotes a Filestore standbyinstance (replica).
func (PromoteReplicaRequest)MarshalJSON¶added inv0.222.0
func (sPromoteReplicaRequest) MarshalJSON() ([]byte,error)
typePscConfig¶added inv0.249.0
type PscConfig struct {// EndpointProject: Optional. Consumer service project in which the Private// Service Connect endpoint would be set up. This is optional, and only// relevant in case the network is a shared VPC. If this is not specified, the// endpoint would be setup in the VPC host project.EndpointProjectstring `json:"endpointProject,omitempty"`// ForceSendFields is a list of field names (e.g. "EndpointProject") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndpointProject") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PscConfig: Private Service Connect configuration.
func (PscConfig)MarshalJSON¶added inv0.249.0
typeReplicaConfig¶added inv0.182.0
type ReplicaConfig struct {// LastActiveSyncTime: Output only. The timestamp of the latest replication// snapshot taken on the active instance and is already replicated safely.LastActiveSyncTimestring `json:"lastActiveSyncTime,omitempty"`// PeerInstance: Optional. The peer instance.PeerInstancestring `json:"peerInstance,omitempty"`// State: Output only. The replica state.//// Possible values:// "STATE_UNSPECIFIED" - State not set.// "CREATING" - The replica is being created.// "READY" - The replica is ready.// "REMOVING" - The replica is being removed.// "FAILED" - The replica is experiencing an issue and might be unusable. You// can get further details from the `stateReasons` field of the `ReplicaConfig`// object.// "PROMOTING" - The replica is being promoted.// "PAUSING" - The replica is being paused.// "PAUSED" - The replica is paused.// "RESUMING" - The replica is being resumed.Statestring `json:"state,omitempty"`// StateReasons: Output only. Additional information about the replication// state, if available.//// Possible values:// "STATE_REASON_UNSPECIFIED" - Reason not specified.// "PEER_INSTANCE_UNREACHABLE" - The peer instance is unreachable.// "REMOVE_FAILED" - The remove replica peer instance operation failed.// "PAUSE_FAILED" - The pause replica operation failed.// "RESUME_FAILED" - The resume replica operation failed.StateReasons []string `json:"stateReasons,omitempty"`// StateUpdateTime: Output only. The time when the replica state was updated.StateUpdateTimestring `json:"stateUpdateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "LastActiveSyncTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastActiveSyncTime") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReplicaConfig: Replica configuration for the instance.
func (ReplicaConfig)MarshalJSON¶added inv0.182.0
func (sReplicaConfig) MarshalJSON() ([]byte,error)
typeReplication¶added inv0.182.0
type Replication struct {// Replicas: Optional. Replication configuration for the replica instance// associated with this instance. Only a single replica is supported.Replicas []*ReplicaConfig `json:"replicas,omitempty"`// Role: Optional. The replication role.//// Possible values:// "ROLE_UNSPECIFIED" - Role not set.// "ACTIVE" - The instance is the `ACTIVE` replication member, functions as// the replication source instance.// "STANDBY" - The instance is the `STANDBY` replication member, functions as// the replication destination instance.Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Replicas") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Replicas") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Replication: Replication specifications.
func (Replication)MarshalJSON¶added inv0.182.0
func (sReplication) MarshalJSON() ([]byte,error)
typeRestoreInstanceRequest¶added inv0.35.0
type RestoreInstanceRequest struct {// FileShare: Required. Name of the file share in the Filestore instance that// the backup is being restored to.FileSharestring `json:"fileShare,omitempty"`// SourceBackup: The resource name of the backup, in the format// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.SourceBackupstring `json:"sourceBackup,omitempty"`// ForceSendFields is a list of field names (e.g. "FileShare") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FileShare") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RestoreInstanceRequest: RestoreInstanceRequest restores an existinginstance's file share from a backup.
func (RestoreInstanceRequest)MarshalJSON¶added inv0.35.0
func (sRestoreInstanceRequest) MarshalJSON() ([]byte,error)
typeRevertInstanceRequest¶added inv0.119.0
type RevertInstanceRequest struct {// TargetSnapshotId: Required. The snapshot resource ID, in the format// 'my-snapshot', where the specified ID is the {snapshot_id} of the fully// qualified name like// `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapsh// ots/{snapshot_id}`TargetSnapshotIdstring `json:"targetSnapshotId,omitempty"`// ForceSendFields is a list of field names (e.g. "TargetSnapshotId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "TargetSnapshotId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RevertInstanceRequest: RevertInstanceRequest reverts the given instance'sfile share to the specified snapshot.
func (RevertInstanceRequest)MarshalJSON¶added inv0.119.0
func (sRevertInstanceRequest) MarshalJSON() ([]byte,error)
typeSchedule¶added inv0.35.0
type Schedule struct {// Day: Allows to define schedule that runs specified day of the week.//// Possible values:// "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified.// "MONDAY" - Monday// "TUESDAY" - Tuesday// "WEDNESDAY" - Wednesday// "THURSDAY" - Thursday// "FRIDAY" - Friday// "SATURDAY" - Saturday// "SUNDAY" - SundayDaystring `json:"day,omitempty"`// Duration: Output only. Duration of the time window, set by service producer.Durationstring `json:"duration,omitempty"`// StartTime: Time within the window to start the operations.StartTime *TimeOfDay `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Schedule: Configure the schedule.
func (Schedule)MarshalJSON¶added inv0.35.0
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeSnapshot¶added inv0.61.0
type Snapshot struct {// CreateTime: Output only. The time when the snapshot was created.CreateTimestring `json:"createTime,omitempty"`// Description: A description of the snapshot with 2048 characters or less.// Requests with longer descriptions will be rejected.Descriptionstring `json:"description,omitempty"`// FilesystemUsedBytes: Output only. The amount of bytes needed to allocate a// full copy of the snapshot contentFilesystemUsedBytesint64 `json:"filesystemUsedBytes,omitempty,string"`// Labels: Resource labels to represent user provided metadata.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The resource name of the snapshot, in the format// `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapsh// ots/{snapshot_id}`.Namestring `json:"name,omitempty"`// State: Output only. The snapshot state.//// Possible values:// "STATE_UNSPECIFIED" - State not set.// "CREATING" - Snapshot is being created.// "READY" - Snapshot is available for use.// "DELETING" - Snapshot is being deleted.Statestring `json:"state,omitempty"`// Tags: Optional. Input only. Immutable. Tag key-value pairs bound to this// resource. Each key must be a namespaced name and each value a short name.// Example: "123456789012/environment" : "production",// "123456789013/costCenter" : "marketing" See the documentation for more// information: - Namespaced name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key// - Short name://https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_valueTags map[string]string `json:"tags,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Snapshot: A Filestore snapshot.
func (Snapshot)MarshalJSON¶added inv0.61.0
typeStatus¶
type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: 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.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).
func (Status)MarshalJSON¶
typeTimeOfDay¶added inv0.35.0
type TimeOfDay struct {// Hours: Hours of a day in 24 hour format. Must be greater than or equal to 0// and typically must be less than or equal to 23. An API may choose to allow// the value "24:00:00" for scenarios like business closing time.Hoursint64 `json:"hours,omitempty"`// Minutes: Minutes of an hour. Must be greater than or equal to 0 and less// than or equal to 59.Minutesint64 `json:"minutes,omitempty"`// Nanos: Fractions of seconds, in nanoseconds. Must be greater than or equal// to 0 and less than or equal to 999,999,999.Nanosint64 `json:"nanos,omitempty"`// Seconds: Seconds of a minute. Must be greater than or equal to 0 and// typically must be less than or equal to 59. An API may allow the value 60 if// it allows leap-seconds.Secondsint64 `json:"seconds,omitempty"`// ForceSendFields is a list of field names (e.g. "Hours") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Hours") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TimeOfDay: Represents a time of day. The date and time zone are either notsignificant or are specified elsewhere. An API may choose to allow leapseconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
func (TimeOfDay)MarshalJSON¶added inv0.35.0
typeUpdatePolicy¶added inv0.35.0
type UpdatePolicy struct {// Channel: Optional. Relative scheduling channel applied to resource.//// Possible values:// "UPDATE_CHANNEL_UNSPECIFIED" - Unspecified channel.// "EARLIER" - Early channel within a customer project.// "LATER" - Later channel within a customer project.// "WEEK1" - ! ! The follow channels can ONLY be used if you adopt the new MW// system! ! ! NOTE: all WEEK channels are assumed to be under a weekly window.// ! There is currently no dedicated channel definitions for Daily windows. !// If you use Daily window, the system will assume a 1d (24Hours) advanced !// notification period b/w EARLY and LATER. ! We may consider support more// flexible daily channel specifications in ! the future. WEEK1 == EARLIER with// minimum 7d advanced notification. {7d, 14d} The system will treat them// equally and will use WEEK1 whenever it can. New customers are encouraged to// use this channel annotation.// "WEEK2" - WEEK2 == LATER with minimum 14d advanced notification {14d,// 21d}.// "WEEK5" - WEEK5 == 40d support. minimum 35d advanced notification {35d,// 42d}.Channelstring `json:"channel,omitempty"`// DenyMaintenancePeriods: Deny Maintenance Period that is applied to resource// to indicate when maintenance is forbidden. The protocol supports// zero-to-many such periods, but the current SLM Rollout implementation only// supports zero-to-one.DenyMaintenancePeriods []*DenyMaintenancePeriod `json:"denyMaintenancePeriods,omitempty"`// Window: Optional. Maintenance window that is applied to resources covered by// this policy.Window *MaintenanceWindow `json:"window,omitempty"`// ForceSendFields is a list of field names (e.g. "Channel") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Channel") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UpdatePolicy: Maintenance policy applicable to instance updates.
func (UpdatePolicy)MarshalJSON¶added inv0.35.0
func (sUpdatePolicy) MarshalJSON() ([]byte,error)
typeWeeklyCycle¶added inv0.35.0
type WeeklyCycle struct {// Schedule: User can specify multiple windows in a week. Minimum of 1 window.Schedule []*Schedule `json:"schedule,omitempty"`// ForceSendFields is a list of field names (e.g. "Schedule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Schedule") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WeeklyCycle: Time window specified for weekly operations.
func (WeeklyCycle)MarshalJSON¶added inv0.35.0
func (sWeeklyCycle) MarshalJSON() ([]byte,error)