file

package
v0.192.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 13, 2024 License: BSD-3-Clause Imports: 16 Imported by: 35

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, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any 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/v1beta1"
...
ctx := context.Background()
fileService, err := file.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.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 OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
fileService, err := file.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
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

type Backup added in v0.31.0 

type Backup struct {
	// CapacityGb: Output only. Capacity of the source file share when the backup
	// was created.
	CapacityGb int64 `json:"capacityGb,omitempty,string"`
	// CreateTime: Output only. The time when the backup was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: A description of the backup with 2048 characters or less.
	// Requests with longer descriptions will be rejected.
	Description string `json:"description,omitempty"`
	// DownloadBytes: Output only. Amount of bytes that will be downloaded if the
	// backup is restored
	DownloadBytes int64 `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.
	FileSystemProtocol string `json:"fileSystemProtocol,omitempty"`
	// KmsKeyName: Immutable. KMS key name used for data encryption.
	KmsKeyName string `json:"kmsKeyName,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_id}/locations/{location_id}/backups/{backup_id}`.
	Name string `json:"name,omitempty"`
	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
	// SourceFileShare: Name of the file share in the source Filestore instance
	// that the backup is created from.
	SourceFileShare string `json:"sourceFileShare,omitempty"`
	// SourceInstance: The resource name of the source Filestore instance, in the
	// format
	// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`,
	// used to create this backup.
	SourceInstance string `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.
	SourceInstanceTier string `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.
	State string `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.
	StorageBytes int64 `json:"storageBytes,omitempty,string"`
	// Tags: Optional. Input only. Immutable. Tag keys/values directly bound to
	// this resource. For example: "123/environment": "production",
	// "123/costCenter": "marketing"
	Tags 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 in v0.31.0 

func (s Backup) MarshalJSON() ([]byte, error)

type CancelOperationRequest 

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type DailyCycle added in v0.35.0 

type DailyCycle struct {
	// Duration: Output only. Duration of the time window, set by service producer.
	Duration string `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 in v0.35.0 

func (s DailyCycle) MarshalJSON() ([]byte, error)

type Date added in v0.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.
	Day int64 `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.
	Month int64 `json:"month,omitempty"`
	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
	// without a year.
	Year int64 `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. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (Date) MarshalJSON added in v0.35.0 

func (s Date) MarshalJSON() ([]byte, error)

type DenyMaintenancePeriod added in v0.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 UTC
	Time *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 is forbidden within the deny period. The start_date must be less than the end_date.

func (DenyMaintenancePeriod) MarshalJSON added in v0.35.0 

func (s DenyMaintenancePeriod) MarshalJSON() ([]byte, error)

type DirectoryServicesConfig added in v0.122.0 

type DirectoryServicesConfig struct {
	// ManagedActiveDirectory: Configuration for Managed Service for Microsoft
	// Active Directory.
	ManagedActiveDirectory *ManagedActiveDirectoryConfig `json:"managedActiveDirectory,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ManagedActiveDirectory") 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. "ManagedActiveDirectory") 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-based authentication.

func (DirectoryServicesConfig) MarshalJSON added in v0.122.0 

func (s DirectoryServicesConfig) MarshalJSON() ([]byte, error)

type Empty 

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 defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type FileShareConfig 

type FileShareConfig struct {
	// CapacityGb: File share capacity in gigabytes (GB). Filestore defines 1 GB as
	// 1024^3 bytes.
	CapacityGb int64 `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.
	Name string `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_id}/locations/{location_id}/backups/{backup_id}`, that
	// this file share has been restored from.
	SourceBackup string `json:"sourceBackup,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 (s FileShareConfig) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1Instance added in v0.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).
	ConsumerDefinedName string `json:"consumerDefinedName,omitempty"`
	// CreateTime: Output only. Timestamp when the resource was created.
	CreateTime string `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.
	InstanceType string `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.
	Name string `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.
	SlmInstanceTemplate string `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.
	State string `json:"state,omitempty"`
	// TenantProjectId: Output only. ID of the associated GCP tenant project. See
	// go/get-instance-metadata.
	TenantProjectId string `json:"tenantProjectId,omitempty"`
	// UpdateTime: Output only. Timestamp when the resource was last modified.
	UpdateTime string `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 represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/in stances/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 in v0.4.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1Instance) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule added in v0.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.
	CanReschedule bool `json:"canReschedule,omitempty"`
	// EndTime: The scheduled end time for the maintenance.
	EndTime string `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.
	RolloutManagementPolicy string `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.
	ScheduleDeadlineTime string `json:"scheduleDeadlineTime,omitempty"`
	// StartTime: The scheduled start time for the maintenance.
	StartTime string `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 in v0.6.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings added in v0.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.
	Exclude bool `json:"exclude,omitempty"`
	// IsRollback: Optional. If the update call is triggered from rollback, set the
	// value as true.
	IsRollback bool `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 and end users to assign settings that controls maintenance on this instance.

func (GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings) MarshalJSON added in v0.26.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata added in v0.6.0 

type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata struct {
	// Location: The location of the node, if different from instance location.
	Location string `json:"location,omitempty"`
	// NodeId: The id of the node. This should be equal to
	// SaasInstanceNode.node_id.
	NodeId string `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: Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.

func (GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata) MarshalJSON added in v0.6.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter added in v0.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 in v0.75.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility added in v0.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 in v0.41.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource added in v0.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'.
	ResourceType string `json:"resourceType,omitempty"`
	// ResourceUrl: URL identifying the resource, e.g.
	// "https://www.googleapis.com/compute/v1/projects/...)".
	ResourceUrl string `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 in v0.4.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility added in v0.16.0 

type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility struct {
	// Eligible: Whether an instance is eligible or ineligible.
	Eligible bool `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.
	Reason string `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 instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.

func (GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility) MarshalJSON added in v0.16.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility) MarshalJSON() ([]byte, error)

type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata added in v0.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.
	Tier string `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: SloMetadata contains resources required for proper SLO classification of the instance.

func (GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata) MarshalJSON added in v0.4.0 

func (s GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata) MarshalJSON() ([]byte, error)

type Instance 

type Instance struct {
	// CapacityGb: The storage capacity of the instance in gigabytes (GB = 1024^3
	// bytes). This capacity can be increased up to `max_capacity_gb` GB in
	// multipliers of `capacity_step_size_gb` GB.
	CapacityGb int64 `json:"capacityGb,omitempty,string"`
	// CapacityStepSizeGb: Output only. The increase/decrease capacity step size.
	CapacityStepSizeGb int64 `json:"capacityStepSizeGb,omitempty,string"`
	// CreateTime: Output only. The time when the instance was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: The description of the instance (2048 characters or less).
	Description string `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.
	Etag string `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.
	KmsKeyName string `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.
	MaxCapacityGb int64 `json:"maxCapacityGb,omitempty,string"`
	// MaxShareCount: The max number of shares allowed.
	MaxShareCount int64 `json:"maxShareCount,omitempty,string"`
	// MultiShareEnabled: Indicates whether this instance uses a multi-share
	// configuration with which it can have more than one file-share or none at
	// all. File-shares are added, updated and removed through the separate
	// file-share APIs.
	MultiShareEnabled bool `json:"multiShareEnabled,omitempty"`
	// Name: Output only. The resource name of the instance, in the format
	// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
	Name string `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"`
	// 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.
	Protocol string `json:"protocol,omitempty"`
	// Replication: Optional. Replicaition configuration.
	Replication *Replication `json:"replication,omitempty"`
	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `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 snapshot or 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.
	//   "REVERTING" - The instance is reverting to a snapshot.
	//   "SUSPENDING" - The instance is in the process of becoming suspended.
	//   "RESUMING" - The instance is in the process of becoming active.
	//   "PROMOTING" - The replica instance is being promoted.
	State string `json:"state,omitempty"`
	// StatusMessage: Output only. Additional information about the instance state,
	// if available.
	StatusMessage string `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 keys/values directly bound to
	// this resource. For example: "123/environment": "production",
	// "123/costCenter": "marketing"
	Tags 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.
	Tier string `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. "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:"-"`
}

Instance: A Filestore instance.

func (Instance) MarshalJSON 

func (s Instance) MarshalJSON() ([]byte, error)

type ListBackupsResponse added in v0.31.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.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: 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 of ListBackupsRequest.

func (ListBackupsResponse) MarshalJSON added in v0.31.0 

func (s ListBackupsResponse) MarshalJSON() ([]byte, error)

type ListInstancesResponse 

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.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: 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 of ListInstancesRequest.

func (ListInstancesResponse) MarshalJSON 

func (s ListInstancesResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse 

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.
	NextPageToken string `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 (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse 

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,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 (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListSharesResponse added in v0.83.0 

type ListSharesResponse 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.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Shares: A list of shares in the project for the specified instance.
	Shares []*Share `json:"shares,omitempty"`
	// Unreachable: 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:"-"`
}

ListSharesResponse: ListSharesResponse is the result of ListSharesRequest.

func (ListSharesResponse) MarshalJSON added in v0.83.0 

func (s ListSharesResponse) MarshalJSON() ([]byte, error)

type ListSnapshotsResponse added in v0.53.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.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Snapshots: A list of snapshots in the project for the specified instance.
	Snapshots []*Snapshot `json:"snapshots,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 of ListSnapshotsRequest.

func (ListSnapshotsResponse) MarshalJSON added in v0.53.0 

func (s ListSnapshotsResponse) MarshalJSON() ([]byte, error)

type Location 

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `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".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `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 

func (s Location) MarshalJSON() ([]byte, error)

type MaintenancePolicy added in v0.35.0 

type MaintenancePolicy struct {
	// CreateTime: Output only. The time when the resource was created.
	CreateTime string `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.
	Description string `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])?`.
	Name string `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.
	State string `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.
	UpdateTime string `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 in v0.35.0 

func (s MaintenancePolicy) MarshalJSON() ([]byte, error)

type MaintenanceWindow added in v0.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 in v0.35.0 

func (s MaintenanceWindow) MarshalJSON() ([]byte, error)

type ManagedActiveDirectoryConfig added in v0.122.0 

type ManagedActiveDirectoryConfig struct {
	// Computer: Required. The computer name is used as a prefix to the mount
	// remote target. Example: if the computer is `my-computer`, the mount command
	// will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.
	Computer string `json:"computer,omitempty"`
	// Domain: Required. The domain resource name, in the format
	// `projects/{project_id}/locations/global/domains/{domain}`.
	Domain string `json:"domain,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Computer") 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. "Computer") 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:"-"`
}

ManagedActiveDirectoryConfig: ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory.

func (ManagedActiveDirectoryConfig) MarshalJSON added in v0.122.0 

func (s ManagedActiveDirectoryConfig) MarshalJSON() ([]byte, error)

type NetworkConfig 

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" - ConnectMode 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.
	ConnectMode string `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.
	Network string `json:"network,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.
	ReservedIpRange string `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 (s NetworkConfig) MarshalJSON() ([]byte, error)

type NfsExportOptions added in v0.27.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).
	AccessMode string `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.
	AnonGid int64 `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.
	AnonUid int64 `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"`
	// SecurityFlavors: The security flavors allowed for mount operations. The
	// default is AUTH_SYS.
	//
	// Possible values:
	//   "SECURITY_FLAVOR_UNSPECIFIED" - SecurityFlavor not set.
	//   "AUTH_SYS" - The user's UNIX user-id and group-ids are transferred "in the
	// clear" (not encrypted) on the network, unauthenticated by the NFS server
	// (default).
	//   "KRB5" - End-user authentication through Kerberos V5.
	//   "KRB5I" - krb5 plus integrity protection (data packets are tamper proof).
	//   "KRB5P" - krb5i plus privacy protection (data packets are tamper proof and
	// encrypted).
	SecurityFlavors []string `json:"securityFlavors,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.
	SquashMode string `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 in v0.27.0 

func (s NfsExportOptions) MarshalJSON() ([]byte, error)

type Operation 

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.
	Done bool `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.
	Metadata googleapi.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}`.
	Name string `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`.
	Response googleapi.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 the result of a network API call.

func (Operation) MarshalJSON 

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata 

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CancelRequested: Output only. Identifies whether the user has requested
	// cancellation of the operation. Operations that have been cancelled
	// successfully have Operation.error value with a google.rpc.Status.code of 1,
	// corresponding to `Code.CANCELLED`.
	CancelRequested bool `json:"cancelRequested,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// StatusDetail: Output only. Human-readable status of the operation, if any.
	StatusDetail string `json:"statusDetail,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `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 (s OperationMetadata) MarshalJSON() ([]byte, error)

type ProjectsLocationsBackupsCreateCall added in v0.31.0 

type ProjectsLocationsBackupsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBackupsCreateCall) BackupId added in v0.31.0 

func (c *ProjectsLocationsBackupsCreateCall) BackupId(backupId string) *ProjectsLocationsBackupsCreateCall

BackupId sets the optional parameter "backupId": Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

func (*ProjectsLocationsBackupsCreateCall) Context added in v0.31.0 

func (c *ProjectsLocationsBackupsCreateCall) Context(ctx context.Context) *ProjectsLocationsBackupsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupsCreateCall) Do added in v0.31.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupsCreateCall) Fields added in v0.31.0 

func (c *ProjectsLocationsBackupsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBackupsCreateCall) Header added in v0.31.0 

func (c *ProjectsLocationsBackupsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsBackupsDeleteCall added in v0.31.0 

type ProjectsLocationsBackupsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBackupsDeleteCall) Context added in v0.31.0 

func (c *ProjectsLocationsBackupsDeleteCall) Context(ctx context.Context) *ProjectsLocationsBackupsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupsDeleteCall) Do added in v0.31.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupsDeleteCall) Fields added in v0.31.0 

func (c *ProjectsLocationsBackupsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBackupsDeleteCall) Header added in v0.31.0 

func (c *ProjectsLocationsBackupsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsBackupsGetCall added in v0.31.0 

type ProjectsLocationsBackupsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBackupsGetCall) Context added in v0.31.0 

func (c *ProjectsLocationsBackupsGetCall) Context(ctx context.Context) *ProjectsLocationsBackupsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupsGetCall) Do added in v0.31.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupsGetCall) Fields added in v0.31.0 

func (c *ProjectsLocationsBackupsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBackupsGetCall) Header added in v0.31.0 

func (c *ProjectsLocationsBackupsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBackupsGetCall) IfNoneMatch added in v0.31.0 

func (c *ProjectsLocationsBackupsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsBackupsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsBackupsListCall added in v0.31.0 

type ProjectsLocationsBackupsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBackupsListCall) Context added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) Context(ctx context.Context) *ProjectsLocationsBackupsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupsListCall) Do added in v0.31.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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupsListCall) Fields added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBackupsListCall) Filter added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) Filter(filter string) *ProjectsLocationsBackupsListCall

Filter sets the optional parameter "filter": List filter.

func (*ProjectsLocationsBackupsListCall) Header added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBackupsListCall) IfNoneMatch added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsBackupsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsBackupsListCall) OrderBy added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) OrderBy(orderBy string) *ProjectsLocationsBackupsListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsBackupsListCall) PageSize added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) PageSize(pageSize int64) *ProjectsLocationsBackupsListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsBackupsListCall) PageToken added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) PageToken(pageToken string) *ProjectsLocationsBackupsListCall

PageToken sets the optional parameter "pageToken": The next_page_token value to use if there are additional results to retrieve for this list request.

func (*ProjectsLocationsBackupsListCall) Pages added in v0.31.0 

func (c *ProjectsLocationsBackupsListCall) Pages(ctx context.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.

type ProjectsLocationsBackupsPatchCall added in v0.31.0 

type ProjectsLocationsBackupsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsBackupsPatchCall) Context added in v0.31.0 

func (c *ProjectsLocationsBackupsPatchCall) Context(ctx context.Context) *ProjectsLocationsBackupsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsBackupsPatchCall) Do added in v0.31.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsBackupsPatchCall) Fields added in v0.31.0 

func (c *ProjectsLocationsBackupsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsBackupsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsBackupsPatchCall) Header added in v0.31.0 

func (c *ProjectsLocationsBackupsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsBackupsPatchCall) UpdateMask added in v0.31.0 

func (c *ProjectsLocationsBackupsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsBackupsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Mask of fields to update. At least one path must be supplied in this field.

type ProjectsLocationsBackupsService added in v0.31.0 

type ProjectsLocationsBackupsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsBackupsService added in v0.31.0 

func NewProjectsLocationsBackupsService(s *Service) *ProjectsLocationsBackupsService

func (*ProjectsLocationsBackupsService) Create added in v0.31.0 

func (r *ProjectsLocationsBackupsService) Create(parent string, backup *Backup) *ProjectsLocationsBackupsCreateCall

Create: Creates a backup.

  • parent: The backup's project and location, in the format `projects/{project_id}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**.

func (*ProjectsLocationsBackupsService) Delete added in v0.31.0 

func (r *ProjectsLocationsBackupsService) Delete(name string) *ProjectsLocationsBackupsDeleteCall

Delete: Deletes a backup.

  • name: The backup resource name, in the format `projects/{project_id}/locations/{location}/backups/{backup_id}`.

func (*ProjectsLocationsBackupsService) Get added in v0.31.0 

func (r *ProjectsLocationsBackupsService) Get(name string) *ProjectsLocationsBackupsGetCall

Get: Gets the details of a specific backup.

  • name: The backup resource name, in the format `projects/{project_id}/locations/{location}/backups/{backup_id}`.

func (*ProjectsLocationsBackupsService) List added in v0.31.0 

func (r *ProjectsLocationsBackupsService) List(parent string) *ProjectsLocationsBackupsListCall

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

  • parent: The project and location for which to retrieve backup information, in the format `projects/{project_id}/locations/{location}`. In Filestore, backup locations map to Google Cloud regions, for example **us-west1**. To retrieve backup information for all locations, use "-" for the `{location}` value.

func (*ProjectsLocationsBackupsService) Patch added in v0.31.0 

func (r *ProjectsLocationsBackupsService) Patch(name string, 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_id}/locations/{location_id}/backups/{backup_id}`.

type ProjectsLocationsGetCall 

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context 

func (c *ProjectsLocationsGetCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header 

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch 

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesCreateCall 

type ProjectsLocationsInstancesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesCreateCall) Context 

func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesCreateCall) Header 

func (c *ProjectsLocationsInstancesCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesCreateCall) InstanceId 

func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceId string) *ProjectsLocationsInstancesCreateCall

InstanceId sets the optional parameter "instanceId": Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

type ProjectsLocationsInstancesDeleteCall 

type ProjectsLocationsInstancesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesDeleteCall) Context 

func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesDeleteCall) Force added in v0.57.0 

func (c *ProjectsLocationsInstancesDeleteCall) Force(force bool) *ProjectsLocationsInstancesDeleteCall

Force sets the optional parameter "force": If set to true, any snapshots of the instance will also be deleted. (Otherwise, the request will only work if the 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 add headers to the request.

type ProjectsLocationsInstancesGetCall 

type ProjectsLocationsInstancesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesGetCall) Context 

func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesGetCall) Header 

func (c *ProjectsLocationsInstancesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesGetCall) IfNoneMatch 

func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesListCall 

type ProjectsLocationsInstancesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesListCall) Context 

func (c *ProjectsLocationsInstancesListCall) Context(ctx context.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesListCall) Fields 

func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesListCall) Filter 

func (c *ProjectsLocationsInstancesListCall) Filter(filter string) *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 add headers to the request.

func (*ProjectsLocationsInstancesListCall) IfNoneMatch 

func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesListCall) OrderBy 

func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsInstancesListCall) PageSize 

func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsInstancesListCall) PageToken 

func (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall

PageToken sets the optional parameter "pageToken": The next_page_token value to use if there are additional results to retrieve for this list request.

func (*ProjectsLocationsInstancesListCall) Pages 

func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.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.

type ProjectsLocationsInstancesPatchCall 

type ProjectsLocationsInstancesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesPatchCall) Context 

func (c *ProjectsLocationsInstancesPatchCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesPatchCall) Header 

func (c *ProjectsLocationsInstancesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesPatchCall) UpdateMask 

func (c *ProjectsLocationsInstancesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels"

type ProjectsLocationsInstancesPromoteReplicaCall added in v0.170.0 

type ProjectsLocationsInstancesPromoteReplicaCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesPromoteReplicaCall) Context added in v0.170.0 

func (c *ProjectsLocationsInstancesPromoteReplicaCall) Context(ctx context.Context) *ProjectsLocationsInstancesPromoteReplicaCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesPromoteReplicaCall) Do added in v0.170.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesPromoteReplicaCall) Fields added in v0.170.0 

func (c *ProjectsLocationsInstancesPromoteReplicaCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPromoteReplicaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesPromoteReplicaCall) Header added in v0.170.0 

func (c *ProjectsLocationsInstancesPromoteReplicaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInstancesRestoreCall added in v0.31.0 

type ProjectsLocationsInstancesRestoreCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesRestoreCall) Context added in v0.31.0 

func (c *ProjectsLocationsInstancesRestoreCall) Context(ctx context.Context) *ProjectsLocationsInstancesRestoreCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesRestoreCall) Do added in v0.31.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesRestoreCall) Fields added in v0.31.0 

func (c *ProjectsLocationsInstancesRestoreCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRestoreCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesRestoreCall) Header added in v0.31.0 

func (c *ProjectsLocationsInstancesRestoreCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInstancesRevertCall added in v0.60.0 

type ProjectsLocationsInstancesRevertCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesRevertCall) Context added in v0.60.0 

func (c *ProjectsLocationsInstancesRevertCall) Context(ctx context.Context) *ProjectsLocationsInstancesRevertCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesRevertCall) Do added in v0.60.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesRevertCall) Fields added in v0.60.0 

func (c *ProjectsLocationsInstancesRevertCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRevertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesRevertCall) Header added in v0.60.0 

func (c *ProjectsLocationsInstancesRevertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInstancesService 

type ProjectsLocationsInstancesService struct {
	Shares *ProjectsLocationsInstancesSharesService

	Snapshots *ProjectsLocationsInstancesSnapshotsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesService 

func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService

func (*ProjectsLocationsInstancesService) Create 

func (r *ProjectsLocationsInstancesService) Create(parent string, instance *Instance) *ProjectsLocationsInstancesCreateCall

Create: Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

  • parent: The instance's project and location, in the format `projects/{project_id}/locations/{location}`. In Filestore, locations map to Google Cloud zones, for example **us-west1-b**.

func (*ProjectsLocationsInstancesService) Delete 

func (r *ProjectsLocationsInstancesService) Delete(name string) *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(name string) *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(parent string) *ProjectsLocationsInstancesListCall

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

  • parent: The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to Google Cloud zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the `{location}` value.

func (*ProjectsLocationsInstancesService) Patch 

func (r *ProjectsLocationsInstancesService) Patch(name string, 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_id}/locations/{location_id}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) PromoteReplica added in v0.170.0 

func (r *ProjectsLocationsInstancesService) PromoteReplica(name string, promotereplicarequest *PromoteReplicaRequest) *ProjectsLocationsInstancesPromoteReplicaCall

PromoteReplica: Promote an 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 in v0.31.0 

func (r *ProjectsLocationsInstancesService) Restore(name string, restoreinstancerequest *RestoreInstanceRequest) *ProjectsLocationsInstancesRestoreCall

Restore: Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

  • name: The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesService) Revert added in v0.60.0 

func (r *ProjectsLocationsInstancesService) Revert(name string, 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}`.

type ProjectsLocationsInstancesSharesCreateCall added in v0.83.0 

type ProjectsLocationsInstancesSharesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSharesCreateCall) Context added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesSharesCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSharesCreateCall) Do added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "file.projects.locations.instances.shares.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSharesCreateCall) Fields added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSharesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSharesCreateCall) Header added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSharesCreateCall) ShareId added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesCreateCall) ShareId(shareId string) *ProjectsLocationsInstancesSharesCreateCall

ShareId sets the optional parameter "shareId": Required. The ID to use for the share. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

type ProjectsLocationsInstancesSharesDeleteCall added in v0.83.0 

type ProjectsLocationsInstancesSharesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSharesDeleteCall) Context added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesSharesDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSharesDeleteCall) Do added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "file.projects.locations.instances.shares.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSharesDeleteCall) Fields added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSharesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSharesDeleteCall) Header added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInstancesSharesGetCall added in v0.83.0 

type ProjectsLocationsInstancesSharesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSharesGetCall) Context added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesSharesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSharesGetCall) Do added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesGetCall) Do(opts ...googleapi.CallOption) (*Share, error)

Do executes the "file.projects.locations.instances.shares.get" call. Any non-2xx status code is an error. Response headers are in either *Share.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSharesGetCall) Fields added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSharesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSharesGetCall) Header added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSharesGetCall) IfNoneMatch added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSharesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesSharesListCall added in v0.83.0 

type ProjectsLocationsInstancesSharesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSharesListCall) Context added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesSharesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSharesListCall) Do added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Do(opts ...googleapi.CallOption) (*ListSharesResponse, error)

Do executes the "file.projects.locations.instances.shares.list" call. Any non-2xx status code is an error. Response headers are in either *ListSharesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSharesListCall) Fields added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSharesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSharesListCall) Filter added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Filter(filter string) *ProjectsLocationsInstancesSharesListCall

Filter sets the optional parameter "filter": List filter.

func (*ProjectsLocationsInstancesSharesListCall) Header added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSharesListCall) IfNoneMatch added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSharesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesSharesListCall) OrderBy added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesSharesListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsInstancesSharesListCall) PageSize added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesSharesListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsInstancesSharesListCall) PageToken added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesSharesListCall

PageToken sets the optional parameter "pageToken": The next_page_token value to use if there are additional results to retrieve for this list request.

func (*ProjectsLocationsInstancesSharesListCall) Pages added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesListCall) Pages(ctx context.Context, f func(*ListSharesResponse) 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.

type ProjectsLocationsInstancesSharesPatchCall added in v0.83.0 

type ProjectsLocationsInstancesSharesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSharesPatchCall) Context added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesSharesPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSharesPatchCall) Do added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "file.projects.locations.instances.shares.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSharesPatchCall) Fields added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSharesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSharesPatchCall) Header added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSharesPatchCall) UpdateMask added in v0.83.0 

func (c *ProjectsLocationsInstancesSharesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesSharesPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "capacity_gb" * "labels" * "nfs_export_options"

type ProjectsLocationsInstancesSharesService added in v0.83.0 

type ProjectsLocationsInstancesSharesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesSharesService added in v0.83.0 

func NewProjectsLocationsInstancesSharesService(s *Service) *ProjectsLocationsInstancesSharesService

func (*ProjectsLocationsInstancesSharesService) Create added in v0.83.0 

func (r *ProjectsLocationsInstancesSharesService) Create(parent string, share *Share) *ProjectsLocationsInstancesSharesCreateCall

Create: Creates a share.

  • parent: The Filestore Instance to create the share for, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesSharesService) Delete added in v0.83.0 

func (r *ProjectsLocationsInstancesSharesService) Delete(name string) *ProjectsLocationsInstancesSharesDeleteCall

Delete: Deletes a share.

  • name: The share resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/share/{ share_id}`.

func (*ProjectsLocationsInstancesSharesService) Get added in v0.83.0 

func (r *ProjectsLocationsInstancesSharesService) Get(name string) *ProjectsLocationsInstancesSharesGetCall

Get: Gets the details of a specific share.

  • name: The share resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/shares/ {share_id}`.

func (*ProjectsLocationsInstancesSharesService) List added in v0.83.0 

func (r *ProjectsLocationsInstancesSharesService) List(parent string) *ProjectsLocationsInstancesSharesListCall

List: Lists all shares for a specified instance.

  • parent: The instance for which to retrieve share information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesSharesService) Patch added in v0.83.0 

func (r *ProjectsLocationsInstancesSharesService) Patch(name string, share *Share) *ProjectsLocationsInstancesSharesPatchCall

Patch: Updates the settings of a specific share.

  • name: Output only. The resource name of the share, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shar es/{share_id}`.

type ProjectsLocationsInstancesSnapshotsCreateCall added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSnapshotsCreateCall) Context added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSnapshotsCreateCall) Do added in v0.53.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSnapshotsCreateCall) Fields added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSnapshotsCreateCall) Header added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSnapshotsCreateCall) SnapshotId added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsCreateCall) SnapshotId(snapshotId string) *ProjectsLocationsInstancesSnapshotsCreateCall

SnapshotId sets the optional parameter "snapshotId": Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

type ProjectsLocationsInstancesSnapshotsDeleteCall added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSnapshotsDeleteCall) Context added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSnapshotsDeleteCall) Do added in v0.53.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSnapshotsDeleteCall) Fields added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSnapshotsDeleteCall) Header added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInstancesSnapshotsGetCall added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSnapshotsGetCall) Context added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSnapshotsGetCall) Do added in v0.53.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSnapshotsGetCall) Fields added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSnapshotsGetCall) Header added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSnapshotsGetCall) IfNoneMatch added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSnapshotsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInstancesSnapshotsListCall added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSnapshotsListCall) Context added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSnapshotsListCall) Do added in v0.53.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSnapshotsListCall) Fields added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSnapshotsListCall) Filter added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) Filter(filter string) *ProjectsLocationsInstancesSnapshotsListCall

Filter sets the optional parameter "filter": List filter.

func (*ProjectsLocationsInstancesSnapshotsListCall) Header added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSnapshotsListCall) IfNoneMatch added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesSnapshotsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInstancesSnapshotsListCall) OrderBy added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesSnapshotsListCall

OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).

func (*ProjectsLocationsInstancesSnapshotsListCall) PageSize added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesSnapshotsListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ProjectsLocationsInstancesSnapshotsListCall) PageToken added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) PageToken(pageToken string) *ProjectsLocationsInstancesSnapshotsListCall

PageToken sets the optional parameter "pageToken": The next_page_token value to use if there are additional results to retrieve for this list request.

func (*ProjectsLocationsInstancesSnapshotsListCall) Pages added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsListCall) Pages(ctx context.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.

type ProjectsLocationsInstancesSnapshotsPatchCall added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInstancesSnapshotsPatchCall) Context added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesSnapshotsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInstancesSnapshotsPatchCall) Do added in v0.53.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInstancesSnapshotsPatchCall) Fields added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesSnapshotsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInstancesSnapshotsPatchCall) Header added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInstancesSnapshotsPatchCall) UpdateMask added in v0.53.0 

func (c *ProjectsLocationsInstancesSnapshotsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesSnapshotsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Mask of fields to update. At least one path must be supplied in this field.

type ProjectsLocationsInstancesSnapshotsService added in v0.53.0 

type ProjectsLocationsInstancesSnapshotsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInstancesSnapshotsService added in v0.53.0 

func NewProjectsLocationsInstancesSnapshotsService(s *Service) *ProjectsLocationsInstancesSnapshotsService

func (*ProjectsLocationsInstancesSnapshotsService) Create added in v0.53.0 

func (r *ProjectsLocationsInstancesSnapshotsService) Create(parent string, 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 in v0.53.0 

func (r *ProjectsLocationsInstancesSnapshotsService) Delete(name string) *ProjectsLocationsInstancesSnapshotsDeleteCall

Delete: Deletes a snapshot.

  • name: The snapshot resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/snapsho ts/{snapshot_id}`.

func (*ProjectsLocationsInstancesSnapshotsService) Get added in v0.53.0 

func (r *ProjectsLocationsInstancesSnapshotsService) Get(name string) *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}/snapsho ts/{snapshot_id}`.

func (*ProjectsLocationsInstancesSnapshotsService) List added in v0.53.0 

func (r *ProjectsLocationsInstancesSnapshotsService) List(parent string) *ProjectsLocationsInstancesSnapshotsListCall

List: Lists all snapshots in a project for either a specified location or for all locations.

  • parent: The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.

func (*ProjectsLocationsInstancesSnapshotsService) Patch added in v0.53.0 

func (r *ProjectsLocationsInstancesSnapshotsService) Patch(name string, 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}/snap shots/{snapshot_id}`.

type ProjectsLocationsListCall 

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context 

func (c *ProjectsLocationsListCall) Context(ctx context.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields 

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter 

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header 

func (c *ProjectsLocationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch 

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) IncludeUnrevealedLocations added in v0.16.0 

func (c *ProjectsLocationsListCall) IncludeUnrevealedLocations(includeUnrevealedLocations bool) *ProjectsLocationsListCall

IncludeUnrevealedLocations sets the optional parameter "includeUnrevealedLocations": If true, the returned list will include locations which are not yet revealed.

func (*ProjectsLocationsListCall) PageSize 

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken 

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages 

func (c *ProjectsLocationsListCall) Pages(ctx context.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.

type ProjectsLocationsOperationsCancelCall 

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context 

func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header 

func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall 

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context 

func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header 

func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall 

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context 

func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether 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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header 

func (c *ProjectsLocationsOperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch 

func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsOperationsListCall 

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context 

func (c *ProjectsLocationsOperationsListCall) Context(ctx context.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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall) Fields 

func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter 

func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *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 add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch 

func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall) PageSize 

func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken 

func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages 

func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.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.

type ProjectsLocationsOperationsService 

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService 

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel 

func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete 

func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get 

func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List 

func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Backups *ProjectsLocationsBackupsService

	Instances *ProjectsLocationsInstancesService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get 

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List 

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type PromoteReplicaRequest added in v0.170.0 

type PromoteReplicaRequest struct {
}

PromoteReplicaRequest: PromoteReplicaRequest promotes a Filestore standby instance (replica).

type ReplicaConfig added in v0.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.
	LastActiveSyncTime string `json:"lastActiveSyncTime,omitempty"`
	// PeerInstance: The peer instance.
	PeerInstance string `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.
	State string `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.
	StateReasons []string `json:"stateReasons,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 in v0.182.0 

func (s ReplicaConfig) MarshalJSON() ([]byte, error)

type Replication added in v0.182.0 

type Replication struct {
	// Replicas: Replicas configuration on the instance. For now, only a single
	// replica config is supported.
	Replicas []*ReplicaConfig `json:"replicas,omitempty"`
	// Role: Output only. The replication role.
	//
	// Possible values:
	//   "ROLE_UNSPECIFIED" - Role not set.
	//   "ACTIVE" - The instance is a Active replication member, functions as the
	// replication source instance.
	//   "STANDBY" - The instance is a Standby replication member, functions as the
	// replication destination instance.
	Role string `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 in v0.182.0 

func (s Replication) MarshalJSON() ([]byte, error)

type RestoreInstanceRequest added in v0.31.0 

type RestoreInstanceRequest struct {
	// FileShare: Required. Name of the file share in the Filestore instance that
	// the backup is being restored to.
	FileShare string `json:"fileShare,omitempty"`
	// SourceBackup: The resource name of the backup, in the format
	// `projects/{project_id}/locations/{location_id}/backups/{backup_id}`.
	SourceBackup string `json:"sourceBackup,omitempty"`
	// SourceSnapshot: The resource name of the snapshot, in the format
	// `projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}`.
	SourceSnapshot string `json:"sourceSnapshot,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 existing instance's file share from a backup.

func (RestoreInstanceRequest) MarshalJSON added in v0.31.0 

func (s RestoreInstanceRequest) MarshalJSON() ([]byte, error)

type RevertInstanceRequest added in v0.60.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}`
	TargetSnapshotId string `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's file share to the specified snapshot.

func (RevertInstanceRequest) MarshalJSON added in v0.60.0 

func (s RevertInstanceRequest) MarshalJSON() ([]byte, error)

type Schedule added in v0.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" - Sunday
	Day string `json:"day,omitempty"`
	// Duration: Output only. Duration of the time window, set by service producer.
	Duration string `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 in v0.35.0 

func (s Schedule) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

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.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Share added in v0.83.0 

type Share struct {
	// Backup: Immutable. Full name of the Cloud Filestore Backup resource that
	// this Share is restored from, in the format of
	// projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if
	// the Share is created from scratch and not restored from a backup.
	Backup string `json:"backup,omitempty"`
	// CapacityGb: File share capacity in gigabytes (GB). Filestore defines 1 GB as
	// 1024^3 bytes. Must be greater than 0.
	CapacityGb int64 `json:"capacityGb,omitempty,string"`
	// CreateTime: Output only. The time when the share was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: A description of the share with 2048 characters or less.
	// Requests with longer descriptions will be rejected.
	Description string `json:"description,omitempty"`
	// Labels: Resource labels to represent user provided metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// MountName: The mount name of the share. Must be 63 characters or less and
	// consist of uppercase or lowercase letters, numbers, and underscores.
	MountName string `json:"mountName,omitempty"`
	// Name: Output only. The resource name of the share, in the format
	// `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares
	// /{share_id}`.
	Name string `json:"name,omitempty"`
	// NfsExportOptions: Nfs Export Options. There is a limit of 10 export options
	// per file share.
	NfsExportOptions []*NfsExportOptions `json:"nfsExportOptions,omitempty"`
	// State: Output only. The share state.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - State not set.
	//   "CREATING" - Share is being created.
	//   "READY" - Share is ready for use.
	//   "DELETING" - Share is being deleted.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Backup") 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. "Backup") 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:"-"`
}

Share: A Filestore share.

func (Share) MarshalJSON added in v0.83.0 

func (s Share) MarshalJSON() ([]byte, error)

type Snapshot added in v0.53.0 

type Snapshot struct {
	// CreateTime: Output only. The time when the snapshot was created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: A description of the snapshot with 2048 characters or less.
	// Requests with longer descriptions will be rejected.
	Description string `json:"description,omitempty"`
	// FilesystemUsedBytes: Output only. The amount of bytes needed to allocate a
	// full copy of the snapshot content
	FilesystemUsedBytes int64 `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}`.
	Name string `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.
	State string `json:"state,omitempty"`
	// Tags: Optional. Input only. Immutable. Tag keys/values directly bound to
	// this resource. For example: "123/environment": "production",
	// "123/costCenter": "marketing"
	Tags 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 in v0.53.0 

func (s Snapshot) MarshalJSON() ([]byte, error)

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `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.
	Message string `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 for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

type TimeOfDay added in v0.35.0 

type TimeOfDay struct {
	// Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API may
	// choose to allow the value "24:00:00" for scenarios like business closing
	// time.
	Hours int64 `json:"hours,omitempty"`
	// Minutes: Minutes of hour of day. Must be from 0 to 59.
	Minutes int64 `json:"minutes,omitempty"`
	// Nanos: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
	Nanos int64 `json:"nanos,omitempty"`
	// Seconds: Seconds of minutes of the time. Must normally be from 0 to 59. An
	// API may allow the value 60 if it allows leap-seconds.
	Seconds int64 `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 not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

func (TimeOfDay) MarshalJSON added in v0.35.0 

func (s TimeOfDay) MarshalJSON() ([]byte, error)

type UpdatePolicy added in v0.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}.
	Channel string `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 in v0.35.0 

func (s UpdatePolicy) MarshalJSON() ([]byte, error)

type WeeklyCycle added in v0.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 in v0.35.0 

func (s WeeklyCycle) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.