Constants
CloudFilestoreManager_ListInstances_FullMethodName, CloudFilestoreManager_GetInstance_FullMethodName, CloudFilestoreManager_CreateInstance_FullMethodName, CloudFilestoreManager_UpdateInstance_FullMethodName, CloudFilestoreManager_RestoreInstance_FullMethodName, CloudFilestoreManager_RevertInstance_FullMethodName, CloudFilestoreManager_DeleteInstance_FullMethodName, CloudFilestoreManager_ListSnapshots_FullMethodName, CloudFilestoreManager_GetSnapshot_FullMethodName, CloudFilestoreManager_CreateSnapshot_FullMethodName, CloudFilestoreManager_DeleteSnapshot_FullMethodName, CloudFilestoreManager_UpdateSnapshot_FullMethodName, CloudFilestoreManager_ListBackups_FullMethodName, CloudFilestoreManager_GetBackup_FullMethodName, CloudFilestoreManager_CreateBackup_FullMethodName, CloudFilestoreManager_DeleteBackup_FullMethodName, CloudFilestoreManager_UpdateBackup_FullMethodName, CloudFilestoreManager_PromoteReplica_FullMethodName
const (
CloudFilestoreManager_ListInstances_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/ListInstances"
CloudFilestoreManager_GetInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/GetInstance"
CloudFilestoreManager_CreateInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/CreateInstance"
CloudFilestoreManager_UpdateInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/UpdateInstance"
CloudFilestoreManager_RestoreInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/RestoreInstance"
CloudFilestoreManager_RevertInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/RevertInstance"
CloudFilestoreManager_DeleteInstance_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/DeleteInstance"
CloudFilestoreManager_ListSnapshots_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/ListSnapshots"
CloudFilestoreManager_GetSnapshot_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/GetSnapshot"
CloudFilestoreManager_CreateSnapshot_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/CreateSnapshot"
CloudFilestoreManager_DeleteSnapshot_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/DeleteSnapshot"
CloudFilestoreManager_UpdateSnapshot_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/UpdateSnapshot"
CloudFilestoreManager_ListBackups_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/ListBackups"
CloudFilestoreManager_GetBackup_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/GetBackup"
CloudFilestoreManager_CreateBackup_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/CreateBackup"
CloudFilestoreManager_DeleteBackup_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/DeleteBackup"
CloudFilestoreManager_UpdateBackup_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/UpdateBackup"
CloudFilestoreManager_PromoteReplica_FullMethodName = "/google.cloud.filestore.v1.CloudFilestoreManager/PromoteReplica"
)Variables
NetworkConfig_AddressMode_name, NetworkConfig_AddressMode_value
var (
NetworkConfig_AddressMode_name = map[int32]string{
0: "ADDRESS_MODE_UNSPECIFIED",
1: "MODE_IPV4",
}
NetworkConfig_AddressMode_value = map[string]int32{
"ADDRESS_MODE_UNSPECIFIED": 0,
"MODE_IPV4": 1,
}
)Enum value maps for NetworkConfig_AddressMode.
NetworkConfig_ConnectMode_name, NetworkConfig_ConnectMode_value
var (
NetworkConfig_ConnectMode_name = map[int32]string{
0: "CONNECT_MODE_UNSPECIFIED",
1: "DIRECT_PEERING",
2: "PRIVATE_SERVICE_ACCESS",
}
NetworkConfig_ConnectMode_value = map[string]int32{
"CONNECT_MODE_UNSPECIFIED": 0,
"DIRECT_PEERING": 1,
"PRIVATE_SERVICE_ACCESS": 2,
}
)Enum value maps for NetworkConfig_ConnectMode.
NfsExportOptions_AccessMode_name, NfsExportOptions_AccessMode_value
var (
NfsExportOptions_AccessMode_name = map[int32]string{
0: "ACCESS_MODE_UNSPECIFIED",
1: "READ_ONLY",
2: "READ_WRITE",
}
NfsExportOptions_AccessMode_value = map[string]int32{
"ACCESS_MODE_UNSPECIFIED": 0,
"READ_ONLY": 1,
"READ_WRITE": 2,
}
)Enum value maps for NfsExportOptions_AccessMode.
NfsExportOptions_SquashMode_name, NfsExportOptions_SquashMode_value
var (
NfsExportOptions_SquashMode_name = map[int32]string{
0: "SQUASH_MODE_UNSPECIFIED",
1: "NO_ROOT_SQUASH",
2: "ROOT_SQUASH",
}
NfsExportOptions_SquashMode_value = map[string]int32{
"SQUASH_MODE_UNSPECIFIED": 0,
"NO_ROOT_SQUASH": 1,
"ROOT_SQUASH": 2,
}
)Enum value maps for NfsExportOptions_SquashMode.
ReplicaConfig_State_name, ReplicaConfig_State_value
var (
ReplicaConfig_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
3: "READY",
4: "REMOVING",
5: "FAILED",
}
ReplicaConfig_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 3,
"REMOVING": 4,
"FAILED": 5,
}
)Enum value maps for ReplicaConfig_State.
ReplicaConfig_StateReason_name, ReplicaConfig_StateReason_value
var (
ReplicaConfig_StateReason_name = map[int32]string{
0: "STATE_REASON_UNSPECIFIED",
1: "PEER_INSTANCE_UNREACHABLE",
2: "REMOVE_FAILED",
}
ReplicaConfig_StateReason_value = map[string]int32{
"STATE_REASON_UNSPECIFIED": 0,
"PEER_INSTANCE_UNREACHABLE": 1,
"REMOVE_FAILED": 2,
}
)Enum value maps for ReplicaConfig_StateReason.
Replication_Role_name, Replication_Role_value
var (
Replication_Role_name = map[int32]string{
0: "ROLE_UNSPECIFIED",
1: "ACTIVE",
2: "STANDBY",
}
Replication_Role_value = map[string]int32{
"ROLE_UNSPECIFIED": 0,
"ACTIVE": 1,
"STANDBY": 2,
}
)Enum value maps for Replication_Role.
Instance_State_name, Instance_State_value
var (
Instance_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "READY",
3: "REPAIRING",
4: "DELETING",
6: "ERROR",
7: "RESTORING",
8: "SUSPENDED",
9: "SUSPENDING",
10: "RESUMING",
12: "REVERTING",
13: "PROMOTING",
}
Instance_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 2,
"REPAIRING": 3,
"DELETING": 4,
"ERROR": 6,
"RESTORING": 7,
"SUSPENDED": 8,
"SUSPENDING": 9,
"RESUMING": 10,
"REVERTING": 12,
"PROMOTING": 13,
}
)Enum value maps for Instance_State.
Instance_Tier_name, Instance_Tier_value
var (
Instance_Tier_name = map[int32]string{
0: "TIER_UNSPECIFIED",
1: "STANDARD",
2: "PREMIUM",
3: "BASIC_HDD",
4: "BASIC_SSD",
5: "HIGH_SCALE_SSD",
6: "ENTERPRISE",
7: "ZONAL",
8: "REGIONAL",
}
Instance_Tier_value = map[string]int32{
"TIER_UNSPECIFIED": 0,
"STANDARD": 1,
"PREMIUM": 2,
"BASIC_HDD": 3,
"BASIC_SSD": 4,
"HIGH_SCALE_SSD": 5,
"ENTERPRISE": 6,
"ZONAL": 7,
"REGIONAL": 8,
}
)Enum value maps for Instance_Tier.
Instance_SuspensionReason_name, Instance_SuspensionReason_value
var (
Instance_SuspensionReason_name = map[int32]string{
0: "SUSPENSION_REASON_UNSPECIFIED",
1: "KMS_KEY_ISSUE",
}
Instance_SuspensionReason_value = map[string]int32{
"SUSPENSION_REASON_UNSPECIFIED": 0,
"KMS_KEY_ISSUE": 1,
}
)Enum value maps for Instance_SuspensionReason.
Instance_FileProtocol_name, Instance_FileProtocol_value
var (
Instance_FileProtocol_name = map[int32]string{
0: "FILE_PROTOCOL_UNSPECIFIED",
1: "NFS_V3",
2: "NFS_V4_1",
}
Instance_FileProtocol_value = map[string]int32{
"FILE_PROTOCOL_UNSPECIFIED": 0,
"NFS_V3": 1,
"NFS_V4_1": 2,
}
)Enum value maps for Instance_FileProtocol.
Snapshot_State_name, Snapshot_State_value
var (
Snapshot_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "READY",
3: "DELETING",
}
Snapshot_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 2,
"DELETING": 3,
}
)Enum value maps for Snapshot_State.
Backup_State_name, Backup_State_value
var (
Backup_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "FINALIZING",
3: "READY",
4: "DELETING",
5: "INVALID",
}
Backup_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"FINALIZING": 2,
"READY": 3,
"DELETING": 4,
"INVALID": 5,
}
)Enum value maps for Backup_State.
CloudFilestoreManager_ServiceDesc
var CloudFilestoreManager_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.filestore.v1.CloudFilestoreManager",
HandlerType: (*CloudFilestoreManagerServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "ListInstances",
Handler: _CloudFilestoreManager_ListInstances_Handler,
},
{
MethodName: "GetInstance",
Handler: _CloudFilestoreManager_GetInstance_Handler,
},
{
MethodName: "CreateInstance",
Handler: _CloudFilestoreManager_CreateInstance_Handler,
},
{
MethodName: "UpdateInstance",
Handler: _CloudFilestoreManager_UpdateInstance_Handler,
},
{
MethodName: "RestoreInstance",
Handler: _CloudFilestoreManager_RestoreInstance_Handler,
},
{
MethodName: "RevertInstance",
Handler: _CloudFilestoreManager_RevertInstance_Handler,
},
{
MethodName: "DeleteInstance",
Handler: _CloudFilestoreManager_DeleteInstance_Handler,
},
{
MethodName: "ListSnapshots",
Handler: _CloudFilestoreManager_ListSnapshots_Handler,
},
{
MethodName: "GetSnapshot",
Handler: _CloudFilestoreManager_GetSnapshot_Handler,
},
{
MethodName: "CreateSnapshot",
Handler: _CloudFilestoreManager_CreateSnapshot_Handler,
},
{
MethodName: "DeleteSnapshot",
Handler: _CloudFilestoreManager_DeleteSnapshot_Handler,
},
{
MethodName: "UpdateSnapshot",
Handler: _CloudFilestoreManager_UpdateSnapshot_Handler,
},
{
MethodName: "ListBackups",
Handler: _CloudFilestoreManager_ListBackups_Handler,
},
{
MethodName: "GetBackup",
Handler: _CloudFilestoreManager_GetBackup_Handler,
},
{
MethodName: "CreateBackup",
Handler: _CloudFilestoreManager_CreateBackup_Handler,
},
{
MethodName: "DeleteBackup",
Handler: _CloudFilestoreManager_DeleteBackup_Handler,
},
{
MethodName: "UpdateBackup",
Handler: _CloudFilestoreManager_UpdateBackup_Handler,
},
{
MethodName: "PromoteReplica",
Handler: _CloudFilestoreManager_PromoteReplica_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/filestore/v1/cloud_filestore_service.proto",
}CloudFilestoreManager_ServiceDesc is the grpc.ServiceDesc for CloudFilestoreManager service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_filestore_v1_cloud_filestore_service_proto
var File_google_cloud_filestore_v1_cloud_filestore_service_proto protoreflect.FileDescriptorFunctions
func RegisterCloudFilestoreManagerServer
func RegisterCloudFilestoreManagerServer(s grpc.ServiceRegistrar, srv CloudFilestoreManagerServer)Backup
type Backup struct {
// Output only. The resource name of the backup, in the format
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// A description of the backup with 2048 characters or less.
// Requests with longer descriptions will be rejected.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The backup state.
State Backup_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.filestore.v1.Backup_State" json:"state,omitempty"`
// Output only. The time when the backup was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Resource labels to represent user provided metadata.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. Capacity of the source file share when the backup was created.
CapacityGb int64 `protobuf:"varint,6,opt,name=capacity_gb,json=capacityGb,proto3" json:"capacity_gb,omitempty"`
// 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 `protobuf:"varint,7,opt,name=storage_bytes,json=storageBytes,proto3" json:"storage_bytes,omitempty"`
// The resource name of the source Filestore instance, in the format
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`,
// used to create this backup.
SourceInstance string `protobuf:"bytes,8,opt,name=source_instance,json=sourceInstance,proto3" json:"source_instance,omitempty"`
// Name of the file share in the source Filestore instance that the
// backup is created from.
SourceFileShare string `protobuf:"bytes,9,opt,name=source_file_share,json=sourceFileShare,proto3" json:"source_file_share,omitempty"`
// Output only. The service tier of the source Filestore instance that this
// backup is created from.
SourceInstanceTier Instance_Tier `protobuf:"varint,10,opt,name=source_instance_tier,json=sourceInstanceTier,proto3,enum=google.cloud.filestore.v1.Instance_Tier" json:"source_instance_tier,omitempty"`
// Output only. Amount of bytes that will be downloaded if the backup is
// restored. This may be different than storage bytes, since sequential
// backups of the same disk will share storage.
DownloadBytes int64 `protobuf:"varint,11,opt,name=download_bytes,json=downloadBytes,proto3" json:"download_bytes,omitempty"`
// Output only. Reserved for future use.
SatisfiesPzs *wrapperspb.BoolValue `protobuf:"bytes,12,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
// Output only. Reserved for future use.
SatisfiesPzi bool `protobuf:"varint,14,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,omitempty"`
// Immutable. KMS key name used for data encryption.
KmsKey string `protobuf:"bytes,13,opt,name=kms_key,json=kmsKey,proto3" json:"kms_key,omitempty"`
// Optional. Input only. Immutable. Tag key-value pairs bound to this
// resource. Each key must be a namespaced name and each value a short name.
// Example:
// "123456789012/environment" : "production",
// "123456789013/costCenter" : "marketing"
// See the documentation for more information:
// - Namespaced name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
// - Short name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
Tags map[string]string `protobuf:"bytes,15,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. The file system protocol of the source Filestore instance that
// this backup is created from.
FileSystemProtocol Instance_FileProtocol `protobuf:"varint,16,opt,name=file_system_protocol,json=fileSystemProtocol,proto3,enum=google.cloud.filestore.v1.Instance_FileProtocol" json:"file_system_protocol,omitempty"`
// contains filtered or unexported fields
}A Filestore backup.
func (*Backup) Descriptor
Deprecated: Use Backup.ProtoReflect.Descriptor instead.
func (*Backup) GetCapacityGb
func (*Backup) GetCreateTime
func (x *Backup) GetCreateTime() *timestamppb.Timestampfunc (*Backup) GetDescription
func (*Backup) GetDownloadBytes
func (*Backup) GetFileSystemProtocol
func (x *Backup) GetFileSystemProtocol() Instance_FileProtocolfunc (*Backup) GetKmsKey
func (*Backup) GetLabels
func (*Backup) GetName
func (*Backup) GetSatisfiesPzi
func (*Backup) GetSatisfiesPzs
func (x *Backup) GetSatisfiesPzs() *wrapperspb.BoolValuefunc (*Backup) GetSourceFileShare
func (*Backup) GetSourceInstance
func (*Backup) GetSourceInstanceTier
func (x *Backup) GetSourceInstanceTier() Instance_Tierfunc (*Backup) GetState
func (x *Backup) GetState() Backup_Statefunc (*Backup) GetStorageBytes
func (*Backup) GetTags
func (*Backup) ProtoMessage
func (*Backup) ProtoMessage()func (*Backup) ProtoReflect
func (x *Backup) ProtoReflect() protoreflect.Messagefunc (*Backup) Reset
func (x *Backup) Reset()func (*Backup) String
Backup_State
type Backup_State int32The backup state.
Backup_STATE_UNSPECIFIED, Backup_CREATING, Backup_FINALIZING, Backup_READY, Backup_DELETING, Backup_INVALID
const (
// State not set.
Backup_STATE_UNSPECIFIED Backup_State = 0
// Backup is being created.
Backup_CREATING Backup_State = 1
// 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.
Backup_FINALIZING Backup_State = 2
// Backup is available for use.
Backup_READY Backup_State = 3
// Backup is being deleted.
Backup_DELETING Backup_State = 4
// Backup is not valid and cannot be used for creating new instances or
// restoring existing instances.
Backup_INVALID Backup_State = 5
)func (Backup_State) Descriptor
func (Backup_State) Descriptor() protoreflect.EnumDescriptorfunc (Backup_State) Enum
func (x Backup_State) Enum() *Backup_Statefunc (Backup_State) EnumDescriptor
func (Backup_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Backup_State.Descriptor instead.
func (Backup_State) Number
func (x Backup_State) Number() protoreflect.EnumNumberfunc (Backup_State) String
func (x Backup_State) String() stringfunc (Backup_State) Type
func (Backup_State) Type() protoreflect.EnumTypeCloudFilestoreManagerClient
type CloudFilestoreManagerClient interface {
// Lists all instances in a project for either a specified location
// or for all locations.
ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
// Gets the details of a specific instance.
GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
// Creates an instance.
// When creating from a backup, the capacity of the new instance needs to be
// equal to or larger than the capacity of the backup (and also equal to or
// larger than the minimum capacity of the tier).
CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the settings of a specific instance.
UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Restores an existing instance's file share from a backup.
//
// The capacity of the instance needs to be equal to or larger than the
// capacity of the backup (and also equal to or larger than the minimum
// capacity of the tier).
RestoreInstance(ctx context.Context, in *RestoreInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Revert an existing instance's file system to a specified snapshot.
RevertInstance(ctx context.Context, in *RevertInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes an instance.
DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists all snapshots in a project for either a specified location
// or for all locations.
ListSnapshots(ctx context.Context, in *ListSnapshotsRequest, opts ...grpc.CallOption) (*ListSnapshotsResponse, error)
// Gets the details of a specific snapshot.
GetSnapshot(ctx context.Context, in *GetSnapshotRequest, opts ...grpc.CallOption) (*Snapshot, error)
// Creates a snapshot.
CreateSnapshot(ctx context.Context, in *CreateSnapshotRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a snapshot.
DeleteSnapshot(ctx context.Context, in *DeleteSnapshotRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the settings of a specific snapshot.
UpdateSnapshot(ctx context.Context, in *UpdateSnapshotRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists all backups in a project for either a specified location or for all
// locations.
ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*ListBackupsResponse, error)
// Gets the details of a specific backup.
GetBackup(ctx context.Context, in *GetBackupRequest, opts ...grpc.CallOption) (*Backup, error)
// Creates a backup.
CreateBackup(ctx context.Context, in *CreateBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a backup.
DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the settings of a specific backup.
UpdateBackup(ctx context.Context, in *UpdateBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Promote the standby instance (replica).
PromoteReplica(ctx context.Context, in *PromoteReplicaRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}CloudFilestoreManagerClient is the client API for CloudFilestoreManager service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewCloudFilestoreManagerClient
func NewCloudFilestoreManagerClient(cc grpc.ClientConnInterface) CloudFilestoreManagerClientCloudFilestoreManagerServer
type CloudFilestoreManagerServer interface {
// Lists all instances in a project for either a specified location
// or for all locations.
ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
// Gets the details of a specific instance.
GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
// Creates an instance.
// When creating from a backup, the capacity of the new instance needs to be
// equal to or larger than the capacity of the backup (and also equal to or
// larger than the minimum capacity of the tier).
CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
// Updates the settings of a specific instance.
UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)
// Restores an existing instance's file share from a backup.
//
// The capacity of the instance needs to be equal to or larger than the
// capacity of the backup (and also equal to or larger than the minimum
// capacity of the tier).
RestoreInstance(context.Context, *RestoreInstanceRequest) (*longrunningpb.Operation, error)
// Revert an existing instance's file system to a specified snapshot.
RevertInstance(context.Context, *RevertInstanceRequest) (*longrunningpb.Operation, error)
// Deletes an instance.
DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)
// Lists all snapshots in a project for either a specified location
// or for all locations.
ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)
// Gets the details of a specific snapshot.
GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)
// Creates a snapshot.
CreateSnapshot(context.Context, *CreateSnapshotRequest) (*longrunningpb.Operation, error)
// Deletes a snapshot.
DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*longrunningpb.Operation, error)
// Updates the settings of a specific snapshot.
UpdateSnapshot(context.Context, *UpdateSnapshotRequest) (*longrunningpb.Operation, error)
// Lists all backups in a project for either a specified location or for all
// locations.
ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
// Gets the details of a specific backup.
GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
// Creates a backup.
CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)
// Deletes a backup.
DeleteBackup(context.Context, *DeleteBackupRequest) (*longrunningpb.Operation, error)
// Updates the settings of a specific backup.
UpdateBackup(context.Context, *UpdateBackupRequest) (*longrunningpb.Operation, error)
// Promote the standby instance (replica).
PromoteReplica(context.Context, *PromoteReplicaRequest) (*longrunningpb.Operation, error)
}CloudFilestoreManagerServer is the server API for CloudFilestoreManager service. All implementations should embed UnimplementedCloudFilestoreManagerServer for forward compatibility
CreateBackupRequest
type CreateBackupRequest struct {
// Required. The backup's project and location, in the format
// `projects/{project_number}/locations/{location}`. In Filestore,
// backup locations map to Google Cloud regions, for example **us-west1**.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
Backup *Backup `protobuf:"bytes,2,opt,name=backup,proto3" json:"backup,omitempty"`
// Required. The ID to use for the backup.
// The ID must be unique within the specified project and location.
//
// This value must start with a lowercase letter followed by up to 62
// lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
// Values that do not match this pattern will trigger an INVALID_ARGUMENT
// error.
BackupId string `protobuf:"bytes,3,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
// contains filtered or unexported fields
}CreateBackupRequest creates a backup.
func (*CreateBackupRequest) Descriptor
func (*CreateBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.
func (*CreateBackupRequest) GetBackup
func (x *CreateBackupRequest) GetBackup() *Backupfunc (*CreateBackupRequest) GetBackupId
func (x *CreateBackupRequest) GetBackupId() stringfunc (*CreateBackupRequest) GetParent
func (x *CreateBackupRequest) GetParent() stringfunc (*CreateBackupRequest) ProtoMessage
func (*CreateBackupRequest) ProtoMessage()func (*CreateBackupRequest) ProtoReflect
func (x *CreateBackupRequest) ProtoReflect() protoreflect.Messagefunc (*CreateBackupRequest) Reset
func (x *CreateBackupRequest) Reset()func (*CreateBackupRequest) String
func (x *CreateBackupRequest) String() stringCreateInstanceRequest
type CreateInstanceRequest struct {
// Required. The instance's project and location, in the format
// `projects/{project_id}/locations/{location}`. In Filestore,
// locations map to Google Cloud zones, for example **us-west1-b**.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The name of the instance to create.
// The name must be unique for the specified project and location.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. An [instance resource][google.cloud.filestore.v1.Instance]
Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// contains filtered or unexported fields
}CreateInstanceRequest creates an instance.
func (*CreateInstanceRequest) Descriptor
func (*CreateInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateInstanceRequest) GetInstance
func (x *CreateInstanceRequest) GetInstance() *Instancefunc (*CreateInstanceRequest) GetInstanceId
func (x *CreateInstanceRequest) GetInstanceId() stringfunc (*CreateInstanceRequest) GetParent
func (x *CreateInstanceRequest) GetParent() stringfunc (*CreateInstanceRequest) ProtoMessage
func (*CreateInstanceRequest) ProtoMessage()func (*CreateInstanceRequest) ProtoReflect
func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*CreateInstanceRequest) Reset
func (x *CreateInstanceRequest) Reset()func (*CreateInstanceRequest) String
func (x *CreateInstanceRequest) String() stringCreateSnapshotRequest
type CreateSnapshotRequest struct {
// Required. The Filestore Instance to create the snapshots of, in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
SnapshotId string `protobuf:"bytes,2,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
// Required. A snapshot resource.
Snapshot *Snapshot `protobuf:"bytes,3,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// contains filtered or unexported fields
}CreateSnapshotRequest creates a snapshot.
func (*CreateSnapshotRequest) Descriptor
func (*CreateSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSnapshotRequest.ProtoReflect.Descriptor instead.
func (*CreateSnapshotRequest) GetParent
func (x *CreateSnapshotRequest) GetParent() stringfunc (*CreateSnapshotRequest) GetSnapshot
func (x *CreateSnapshotRequest) GetSnapshot() *Snapshotfunc (*CreateSnapshotRequest) GetSnapshotId
func (x *CreateSnapshotRequest) GetSnapshotId() stringfunc (*CreateSnapshotRequest) ProtoMessage
func (*CreateSnapshotRequest) ProtoMessage()func (*CreateSnapshotRequest) ProtoReflect
func (x *CreateSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSnapshotRequest) Reset
func (x *CreateSnapshotRequest) Reset()func (*CreateSnapshotRequest) String
func (x *CreateSnapshotRequest) String() stringDeleteBackupRequest
type DeleteBackupRequest struct {
// Required. The backup resource name, in the format
// `projects/{project_number}/locations/{location}/backups/{backup_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}DeleteBackupRequest deletes a backup.
func (*DeleteBackupRequest) Descriptor
func (*DeleteBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.
func (*DeleteBackupRequest) GetName
func (x *DeleteBackupRequest) GetName() stringfunc (*DeleteBackupRequest) ProtoMessage
func (*DeleteBackupRequest) ProtoMessage()func (*DeleteBackupRequest) ProtoReflect
func (x *DeleteBackupRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteBackupRequest) Reset
func (x *DeleteBackupRequest) Reset()func (*DeleteBackupRequest) String
func (x *DeleteBackupRequest) String() stringDeleteInstanceRequest
type DeleteInstanceRequest struct {
// Required. The instance resource name, in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// If set to true, all snapshots of the instance will also be deleted.
// (Otherwise, the request will only work if the instance has no snapshots.)
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}DeleteInstanceRequest deletes an instance.
func (*DeleteInstanceRequest) Descriptor
func (*DeleteInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.
func (*DeleteInstanceRequest) GetForce
func (x *DeleteInstanceRequest) GetForce() boolfunc (*DeleteInstanceRequest) GetName
func (x *DeleteInstanceRequest) GetName() stringfunc (*DeleteInstanceRequest) ProtoMessage
func (*DeleteInstanceRequest) ProtoMessage()func (*DeleteInstanceRequest) ProtoReflect
func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteInstanceRequest) Reset
func (x *DeleteInstanceRequest) Reset()func (*DeleteInstanceRequest) String
func (x *DeleteInstanceRequest) String() stringDeleteSnapshotRequest
type DeleteSnapshotRequest struct {
// Required. The snapshot resource name, in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}DeleteSnapshotRequest deletes a snapshot.
func (*DeleteSnapshotRequest) Descriptor
func (*DeleteSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteSnapshotRequest.ProtoReflect.Descriptor instead.
func (*DeleteSnapshotRequest) GetName
func (x *DeleteSnapshotRequest) GetName() stringfunc (*DeleteSnapshotRequest) ProtoMessage
func (*DeleteSnapshotRequest) ProtoMessage()func (*DeleteSnapshotRequest) ProtoReflect
func (x *DeleteSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteSnapshotRequest) Reset
func (x *DeleteSnapshotRequest) Reset()func (*DeleteSnapshotRequest) String
func (x *DeleteSnapshotRequest) String() stringFileShareConfig
type FileShareConfig struct {
// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// File share capacity in gigabytes (GB).
// Filestore defines 1 GB as 1024^3 bytes.
CapacityGb int64 `protobuf:"varint,2,opt,name=capacity_gb,json=capacityGb,proto3" json:"capacity_gb,omitempty"`
// The source that this file share has been restored from. Empty if the file
// share is created from scratch.
//
// Types that are assignable to Source:
//
// *FileShareConfig_SourceBackup
Source isFileShareConfig_Source `protobuf_oneof:"source"`
// Nfs Export Options.
// There is a limit of 10 export options per file share.
NfsExportOptions []*NfsExportOptions `protobuf:"bytes,7,rep,name=nfs_export_options,json=nfsExportOptions,proto3" json:"nfs_export_options,omitempty"`
// contains filtered or unexported fields
}File share configuration for the instance.
func (*FileShareConfig) Descriptor
func (*FileShareConfig) Descriptor() ([]byte, []int)Deprecated: Use FileShareConfig.ProtoReflect.Descriptor instead.
func (*FileShareConfig) GetCapacityGb
func (x *FileShareConfig) GetCapacityGb() int64func (*FileShareConfig) GetName
func (x *FileShareConfig) GetName() stringfunc (*FileShareConfig) GetNfsExportOptions
func (x *FileShareConfig) GetNfsExportOptions() []*NfsExportOptionsfunc (*FileShareConfig) GetSource
func (m *FileShareConfig) GetSource() isFileShareConfig_Sourcefunc (*FileShareConfig) GetSourceBackup
func (x *FileShareConfig) GetSourceBackup() stringfunc (*FileShareConfig) ProtoMessage
func (*FileShareConfig) ProtoMessage()func (*FileShareConfig) ProtoReflect
func (x *FileShareConfig) ProtoReflect() protoreflect.Messagefunc (*FileShareConfig) Reset
func (x *FileShareConfig) Reset()func (*FileShareConfig) String
func (x *FileShareConfig) String() stringFileShareConfig_SourceBackup
type FileShareConfig_SourceBackup struct {
// The resource name of the backup, in the format
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`,
// that this file share has been restored from.
SourceBackup string `protobuf:"bytes,8,opt,name=source_backup,json=sourceBackup,proto3,oneof"`
}GetBackupRequest
type GetBackupRequest struct {
// Required. The backup resource name, in the format
// `projects/{project_number}/locations/{location}/backups/{backup_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}GetBackupRequest gets the state of a backup.
func (*GetBackupRequest) Descriptor
func (*GetBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.
func (*GetBackupRequest) GetName
func (x *GetBackupRequest) GetName() stringfunc (*GetBackupRequest) ProtoMessage
func (*GetBackupRequest) ProtoMessage()func (*GetBackupRequest) ProtoReflect
func (x *GetBackupRequest) ProtoReflect() protoreflect.Messagefunc (*GetBackupRequest) Reset
func (x *GetBackupRequest) Reset()func (*GetBackupRequest) String
func (x *GetBackupRequest) String() stringGetInstanceRequest
type GetInstanceRequest struct {
// Required. The instance resource name, in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}GetInstanceRequest gets the state of an instance.
func (*GetInstanceRequest) Descriptor
func (*GetInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceRequest) GetName
func (x *GetInstanceRequest) GetName() stringfunc (*GetInstanceRequest) ProtoMessage
func (*GetInstanceRequest) ProtoMessage()func (*GetInstanceRequest) ProtoReflect
func (x *GetInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*GetInstanceRequest) Reset
func (x *GetInstanceRequest) Reset()func (*GetInstanceRequest) String
func (x *GetInstanceRequest) String() stringGetSnapshotRequest
type GetSnapshotRequest struct {
// Required. The snapshot resource name, in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}GetSnapshotRequest gets the state of a snapshot.
func (*GetSnapshotRequest) Descriptor
func (*GetSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use GetSnapshotRequest.ProtoReflect.Descriptor instead.
func (*GetSnapshotRequest) GetName
func (x *GetSnapshotRequest) GetName() stringfunc (*GetSnapshotRequest) ProtoMessage
func (*GetSnapshotRequest) ProtoMessage()func (*GetSnapshotRequest) ProtoReflect
func (x *GetSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*GetSnapshotRequest) Reset
func (x *GetSnapshotRequest) Reset()func (*GetSnapshotRequest) String
func (x *GetSnapshotRequest) String() stringInstance
type Instance struct {
// Output only. The resource name of the instance, in the format
// `projects/{project}/locations/{location}/instances/{instance}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The description of the instance (2048 characters or less).
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The instance state.
State Instance_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.filestore.v1.Instance_State" json:"state,omitempty"`
// Output only. Additional information about the instance state, if available.
StatusMessage string `protobuf:"bytes,6,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// Output only. The time when the instance was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The service tier of the instance.
Tier Instance_Tier `protobuf:"varint,8,opt,name=tier,proto3,enum=google.cloud.filestore.v1.Instance_Tier" json:"tier,omitempty"`
// Resource labels to represent user provided metadata.
Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// File system shares on the instance.
// For this version, only a single file share is supported.
FileShares []*FileShareConfig `protobuf:"bytes,10,rep,name=file_shares,json=fileShares,proto3" json:"file_shares,omitempty"`
// VPC networks to which the instance is connected.
// For this version, only a single network is supported.
Networks []*NetworkConfig `protobuf:"bytes,11,rep,name=networks,proto3" json:"networks,omitempty"`
// Server-specified ETag for the instance resource to prevent simultaneous
// updates from overwriting each other.
Etag string `protobuf:"bytes,12,opt,name=etag,proto3" json:"etag,omitempty"`
// Output only. Reserved for future use.
SatisfiesPzs *wrapperspb.BoolValue `protobuf:"bytes,13,opt,name=satisfies_pzs,json=satisfiesPzs,proto3" json:"satisfies_pzs,omitempty"`
// Output only. Reserved for future use.
SatisfiesPzi bool `protobuf:"varint,18,opt,name=satisfies_pzi,json=satisfiesPzi,proto3" json:"satisfies_pzi,omitempty"`
// KMS key name used for data encryption.
KmsKeyName string `protobuf:"bytes,14,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// Output only. Field indicates all the reasons the instance is in "SUSPENDED"
// state.
SuspensionReasons []Instance_SuspensionReason `protobuf:"varint,15,rep,packed,name=suspension_reasons,json=suspensionReasons,proto3,enum=google.cloud.filestore.v1.Instance_SuspensionReason" json:"suspension_reasons,omitempty"`
// Optional. Replication configuration.
Replication *Replication `protobuf:"bytes,19,opt,name=replication,proto3" json:"replication,omitempty"`
// Optional. Input only. Immutable. Tag key-value pairs bound to this
// resource. Each key must be a namespaced name and each value a short name.
// Example:
// "123456789012/environment" : "production",
// "123456789013/costCenter" : "marketing"
// See the documentation for more information:
// - Namespaced name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
// - Short name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
Tags map[string]string `protobuf:"bytes,20,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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`.
Protocol Instance_FileProtocol `protobuf:"varint,21,opt,name=protocol,proto3,enum=google.cloud.filestore.v1.Instance_FileProtocol" json:"protocol,omitempty"`
// Output only. Indicates whether this instance supports configuring its
// performance. If true, the user can configure the instance's performance by
// using the 'performance_config' field.
CustomPerformanceSupported bool `protobuf:"varint,23,opt,name=custom_performance_supported,json=customPerformanceSupported,proto3" json:"custom_performance_supported,omitempty"`
// Optional. Used to configure performance.
PerformanceConfig *Instance_PerformanceConfig `protobuf:"bytes,24,opt,name=performance_config,json=performanceConfig,proto3" json:"performance_config,omitempty"`
// Output only. Used for getting performance limits.
PerformanceLimits *Instance_PerformanceLimits `protobuf:"bytes,25,opt,name=performance_limits,json=performanceLimits,proto3" json:"performance_limits,omitempty"`
// Optional. Indicates whether the instance is protected against deletion.
DeletionProtectionEnabled bool `protobuf:"varint,26,opt,name=deletion_protection_enabled,json=deletionProtectionEnabled,proto3" json:"deletion_protection_enabled,omitempty"`
// Optional. The reason for enabling deletion protection.
DeletionProtectionReason string `protobuf:"bytes,27,opt,name=deletion_protection_reason,json=deletionProtectionReason,proto3" json:"deletion_protection_reason,omitempty"`
// contains filtered or unexported fields
}A Filestore instance.
func (*Instance) Descriptor
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) GetCreateTime
func (x *Instance) GetCreateTime() *timestamppb.Timestampfunc (*Instance) GetCustomPerformanceSupported
func (*Instance) GetDeletionProtectionEnabled
func (*Instance) GetDeletionProtectionReason
func (*Instance) GetDescription
func (*Instance) GetEtag
func (*Instance) GetFileShares
func (x *Instance) GetFileShares() []*FileShareConfigfunc (*Instance) GetKmsKeyName
func (*Instance) GetLabels
func (*Instance) GetName
func (*Instance) GetNetworks
func (x *Instance) GetNetworks() []*NetworkConfigfunc (*Instance) GetPerformanceConfig
func (x *Instance) GetPerformanceConfig() *Instance_PerformanceConfigfunc (*Instance) GetPerformanceLimits
func (x *Instance) GetPerformanceLimits() *Instance_PerformanceLimitsfunc (*Instance) GetProtocol
func (x *Instance) GetProtocol() Instance_FileProtocolfunc (*Instance) GetReplication
func (x *Instance) GetReplication() *Replicationfunc (*Instance) GetSatisfiesPzi
func (*Instance) GetSatisfiesPzs
func (x *Instance) GetSatisfiesPzs() *wrapperspb.BoolValuefunc (*Instance) GetState
func (x *Instance) GetState() Instance_Statefunc (*Instance) GetStatusMessage
func (*Instance) GetSuspensionReasons
func (x *Instance) GetSuspensionReasons() []Instance_SuspensionReasonfunc (*Instance) GetTags
func (*Instance) GetTier
func (x *Instance) GetTier() Instance_Tierfunc (*Instance) ProtoMessage
func (*Instance) ProtoMessage()func (*Instance) ProtoReflect
func (x *Instance) ProtoReflect() protoreflect.Messagefunc (*Instance) Reset
func (x *Instance) Reset()func (*Instance) String
Instance_FileProtocol
type Instance_FileProtocol int32File access protocol.
Instance_FILE_PROTOCOL_UNSPECIFIED, Instance_NFS_V3, Instance_NFS_V4_1
const (
// FILE_PROTOCOL_UNSPECIFIED serves a "not set" default value when
// a FileProtocol is a separate field in a message.
Instance_FILE_PROTOCOL_UNSPECIFIED Instance_FileProtocol = 0
// NFS 3.0.
Instance_NFS_V3 Instance_FileProtocol = 1
// NFS 4.1.
Instance_NFS_V4_1 Instance_FileProtocol = 2
)func (Instance_FileProtocol) Descriptor
func (Instance_FileProtocol) Descriptor() protoreflect.EnumDescriptorfunc (Instance_FileProtocol) Enum
func (x Instance_FileProtocol) Enum() *Instance_FileProtocolfunc (Instance_FileProtocol) EnumDescriptor
func (Instance_FileProtocol) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_FileProtocol.Descriptor instead.
func (Instance_FileProtocol) Number
func (x Instance_FileProtocol) Number() protoreflect.EnumNumberfunc (Instance_FileProtocol) String
func (x Instance_FileProtocol) String() stringfunc (Instance_FileProtocol) Type
func (Instance_FileProtocol) Type() protoreflect.EnumTypeInstance_FixedIOPS
type Instance_FixedIOPS struct {
// Required. Maximum IOPS.
MaxIops int64 `protobuf:"varint,2,opt,name=max_iops,json=maxIops,proto3" json:"max_iops,omitempty"`
// contains filtered or unexported fields
}Fixed IOPS (input/output operations per second) parameters.
func (*Instance_FixedIOPS) Descriptor
func (*Instance_FixedIOPS) Descriptor() ([]byte, []int)Deprecated: Use Instance_FixedIOPS.ProtoReflect.Descriptor instead.
func (*Instance_FixedIOPS) GetMaxIops
func (x *Instance_FixedIOPS) GetMaxIops() int64func (*Instance_FixedIOPS) ProtoMessage
func (*Instance_FixedIOPS) ProtoMessage()func (*Instance_FixedIOPS) ProtoReflect
func (x *Instance_FixedIOPS) ProtoReflect() protoreflect.Messagefunc (*Instance_FixedIOPS) Reset
func (x *Instance_FixedIOPS) Reset()func (*Instance_FixedIOPS) String
func (x *Instance_FixedIOPS) String() stringInstance_IOPSPerTB
type Instance_IOPSPerTB struct {
// Required. Maximum IOPS per TiB.
MaxIopsPerTb int64 `protobuf:"varint,2,opt,name=max_iops_per_tb,json=maxIopsPerTb,proto3" json:"max_iops_per_tb,omitempty"`
// contains filtered or unexported fields
}IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).
func (*Instance_IOPSPerTB) Descriptor
func (*Instance_IOPSPerTB) Descriptor() ([]byte, []int)Deprecated: Use Instance_IOPSPerTB.ProtoReflect.Descriptor instead.
func (*Instance_IOPSPerTB) GetMaxIopsPerTb
func (x *Instance_IOPSPerTB) GetMaxIopsPerTb() int64func (*Instance_IOPSPerTB) ProtoMessage
func (*Instance_IOPSPerTB) ProtoMessage()func (*Instance_IOPSPerTB) ProtoReflect
func (x *Instance_IOPSPerTB) ProtoReflect() protoreflect.Messagefunc (*Instance_IOPSPerTB) Reset
func (x *Instance_IOPSPerTB) Reset()func (*Instance_IOPSPerTB) String
func (x *Instance_IOPSPerTB) String() stringInstance_PerformanceConfig
type Instance_PerformanceConfig struct {
// Types that are assignable to Mode:
//
// *Instance_PerformanceConfig_IopsPerTb
// *Instance_PerformanceConfig_FixedIops
Mode isInstance_PerformanceConfig_Mode `protobuf_oneof:"mode"`
// contains filtered or unexported fields
}Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).
func (*Instance_PerformanceConfig) Descriptor
func (*Instance_PerformanceConfig) Descriptor() ([]byte, []int)Deprecated: Use Instance_PerformanceConfig.ProtoReflect.Descriptor instead.
func (*Instance_PerformanceConfig) GetFixedIops
func (x *Instance_PerformanceConfig) GetFixedIops() *Instance_FixedIOPSfunc (*Instance_PerformanceConfig) GetIopsPerTb
func (x *Instance_PerformanceConfig) GetIopsPerTb() *Instance_IOPSPerTBfunc (*Instance_PerformanceConfig) GetMode
func (m *Instance_PerformanceConfig) GetMode() isInstance_PerformanceConfig_Modefunc (*Instance_PerformanceConfig) ProtoMessage
func (*Instance_PerformanceConfig) ProtoMessage()func (*Instance_PerformanceConfig) ProtoReflect
func (x *Instance_PerformanceConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_PerformanceConfig) Reset
func (x *Instance_PerformanceConfig) Reset()func (*Instance_PerformanceConfig) String
func (x *Instance_PerformanceConfig) String() stringInstance_PerformanceConfig_FixedIops
type Instance_PerformanceConfig_FixedIops struct {
// Choose a fixed provisioned IOPS value for the instance, which will
// remain constant regardless of instance capacity. Value must be a
// multiple of 1000.
//
// If the chosen value is outside the supported range for the instance's
// capacity during instance creation, instance creation will fail with an
// `InvalidArgument` error. Similarly, if an instance capacity update
// would result in a value outside the supported range, the update will
// fail with an `InvalidArgument` error.
FixedIops *Instance_FixedIOPS `protobuf:"bytes,2,opt,name=fixed_iops,json=fixedIops,proto3,oneof"`
}Instance_PerformanceConfig_IopsPerTb
type Instance_PerformanceConfig_IopsPerTb struct {
// Provision IOPS dynamically based on the capacity of the instance.
// Provisioned IOPS will be calculated by multiplying the capacity of the
// instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB
// instance with an `iops_per_tb` value of 17000 the provisioned IOPS will
// be 34000.
//
// If the calculated value is outside the supported range for the
// instance's capacity during instance creation, instance creation will
// fail with an `InvalidArgument` error. Similarly, if an instance
// capacity update would result in a value outside the supported range,
// the update will fail with an `InvalidArgument` error.
IopsPerTb *Instance_IOPSPerTB `protobuf:"bytes,4,opt,name=iops_per_tb,json=iopsPerTb,proto3,oneof"`
}Instance_PerformanceLimits
type Instance_PerformanceLimits struct {
// Output only. The max IOPS.
MaxIops int64 `protobuf:"varint,7,opt,name=max_iops,json=maxIops,proto3" json:"max_iops,omitempty"`
// Output only. The max read IOPS.
MaxReadIops int64 `protobuf:"varint,1,opt,name=max_read_iops,json=maxReadIops,proto3" json:"max_read_iops,omitempty"`
// Output only. The max write IOPS.
MaxWriteIops int64 `protobuf:"varint,2,opt,name=max_write_iops,json=maxWriteIops,proto3" json:"max_write_iops,omitempty"`
// Output only. The max read throughput in bytes per second.
MaxReadThroughputBps int64 `protobuf:"varint,5,opt,name=max_read_throughput_bps,json=maxReadThroughputBps,proto3" json:"max_read_throughput_bps,omitempty"`
// Output only. The max write throughput in bytes per second.
MaxWriteThroughputBps int64 `protobuf:"varint,6,opt,name=max_write_throughput_bps,json=maxWriteThroughputBps,proto3" json:"max_write_throughput_bps,omitempty"`
// contains filtered or unexported fields
}The enforced performance limits, calculated from the instance's performance configuration.
func (*Instance_PerformanceLimits) Descriptor
func (*Instance_PerformanceLimits) Descriptor() ([]byte, []int)Deprecated: Use Instance_PerformanceLimits.ProtoReflect.Descriptor instead.
func (*Instance_PerformanceLimits) GetMaxIops
func (x *Instance_PerformanceLimits) GetMaxIops() int64func (*Instance_PerformanceLimits) GetMaxReadIops
func (x *Instance_PerformanceLimits) GetMaxReadIops() int64func (*Instance_PerformanceLimits) GetMaxReadThroughputBps
func (x *Instance_PerformanceLimits) GetMaxReadThroughputBps() int64func (*Instance_PerformanceLimits) GetMaxWriteIops
func (x *Instance_PerformanceLimits) GetMaxWriteIops() int64func (*Instance_PerformanceLimits) GetMaxWriteThroughputBps
func (x *Instance_PerformanceLimits) GetMaxWriteThroughputBps() int64func (*Instance_PerformanceLimits) ProtoMessage
func (*Instance_PerformanceLimits) ProtoMessage()func (*Instance_PerformanceLimits) ProtoReflect
func (x *Instance_PerformanceLimits) ProtoReflect() protoreflect.Messagefunc (*Instance_PerformanceLimits) Reset
func (x *Instance_PerformanceLimits) Reset()func (*Instance_PerformanceLimits) String
func (x *Instance_PerformanceLimits) String() stringInstance_State
type Instance_State int32The instance state.
Instance_STATE_UNSPECIFIED, Instance_CREATING, Instance_READY, Instance_REPAIRING, Instance_DELETING, Instance_ERROR, Instance_RESTORING, Instance_SUSPENDED, Instance_SUSPENDING, Instance_RESUMING, Instance_REVERTING, Instance_PROMOTING
const (
// State not set.
Instance_STATE_UNSPECIFIED Instance_State = 0
// The instance is being created.
Instance_CREATING Instance_State = 1
// The instance is available for use.
Instance_READY Instance_State = 2
// Work is being done on the instance. You can get further details from the
// `statusMessage` field of the `Instance` resource.
Instance_REPAIRING Instance_State = 3
// The instance is shutting down.
Instance_DELETING Instance_State = 4
// The instance is experiencing an issue and might be unusable. You can get
// further details from the `statusMessage` field of the `Instance`
// resource.
Instance_ERROR Instance_State = 6
// The instance is restoring a backup to an existing file share and may be
// unusable during this time.
Instance_RESTORING Instance_State = 7
// The instance is suspended. You can get further details from
// the `suspension_reasons` field of the `Instance` resource.
Instance_SUSPENDED Instance_State = 8
// The instance is in the process of becoming suspended.
Instance_SUSPENDING Instance_State = 9
// The instance is in the process of becoming active.
Instance_RESUMING Instance_State = 10
// The instance is reverting to a snapshot.
Instance_REVERTING Instance_State = 12
// The replica instance is being promoted.
Instance_PROMOTING Instance_State = 13
)func (Instance_State) Descriptor
func (Instance_State) Descriptor() protoreflect.EnumDescriptorfunc (Instance_State) Enum
func (x Instance_State) Enum() *Instance_Statefunc (Instance_State) EnumDescriptor
func (Instance_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_State.Descriptor instead.
func (Instance_State) Number
func (x Instance_State) Number() protoreflect.EnumNumberfunc (Instance_State) String
func (x Instance_State) String() stringfunc (Instance_State) Type
func (Instance_State) Type() protoreflect.EnumTypeInstance_SuspensionReason
type Instance_SuspensionReason int32SuspensionReason contains the possible reasons for a suspension.
Instance_SUSPENSION_REASON_UNSPECIFIED, Instance_KMS_KEY_ISSUE
const (
// Not set.
Instance_SUSPENSION_REASON_UNSPECIFIED Instance_SuspensionReason = 0
// The KMS key used by the instance is either revoked or denied access to.
Instance_KMS_KEY_ISSUE Instance_SuspensionReason = 1
)func (Instance_SuspensionReason) Descriptor
func (Instance_SuspensionReason) Descriptor() protoreflect.EnumDescriptorfunc (Instance_SuspensionReason) Enum
func (x Instance_SuspensionReason) Enum() *Instance_SuspensionReasonfunc (Instance_SuspensionReason) EnumDescriptor
func (Instance_SuspensionReason) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_SuspensionReason.Descriptor instead.
func (Instance_SuspensionReason) Number
func (x Instance_SuspensionReason) Number() protoreflect.EnumNumberfunc (Instance_SuspensionReason) String
func (x Instance_SuspensionReason) String() stringfunc (Instance_SuspensionReason) Type
func (Instance_SuspensionReason) Type() protoreflect.EnumTypeInstance_Tier
type Instance_Tier int32Available service tiers.
Instance_TIER_UNSPECIFIED, Instance_STANDARD, Instance_PREMIUM, Instance_BASIC_HDD, Instance_BASIC_SSD, Instance_HIGH_SCALE_SSD, Instance_ENTERPRISE, Instance_ZONAL, Instance_REGIONAL
const (
// Not set.
Instance_TIER_UNSPECIFIED Instance_Tier = 0
// STANDARD tier. BASIC_HDD is the preferred term for this tier.
Instance_STANDARD Instance_Tier = 1
// PREMIUM tier. BASIC_SSD is the preferred term for this tier.
Instance_PREMIUM Instance_Tier = 2
// BASIC instances offer a maximum capacity of 63.9 TB.
// BASIC_HDD is an alias for STANDARD Tier, offering economical
// performance backed by HDD.
Instance_BASIC_HDD Instance_Tier = 3
// 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.
Instance_BASIC_SSD Instance_Tier = 4
// HIGH_SCALE instances offer expanded capacity and performance scaling
// capabilities.
Instance_HIGH_SCALE_SSD Instance_Tier = 5
// ENTERPRISE instances offer the features and availability needed for
// mission-critical workloads.
Instance_ENTERPRISE Instance_Tier = 6
// ZONAL instances offer expanded capacity and performance scaling
// capabilities.
Instance_ZONAL Instance_Tier = 7
// REGIONAL instances offer the features and availability needed for
// mission-critical workloads.
Instance_REGIONAL Instance_Tier = 8
)func (Instance_Tier) Descriptor
func (Instance_Tier) Descriptor() protoreflect.EnumDescriptorfunc (Instance_Tier) Enum
func (x Instance_Tier) Enum() *Instance_Tierfunc (Instance_Tier) EnumDescriptor
func (Instance_Tier) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_Tier.Descriptor instead.
func (Instance_Tier) Number
func (x Instance_Tier) Number() protoreflect.EnumNumberfunc (Instance_Tier) String
func (x Instance_Tier) String() stringfunc (Instance_Tier) Type
func (Instance_Tier) Type() protoreflect.EnumTypeListBackupsRequest
type ListBackupsRequest struct {
// Required. The project and location for which to retrieve backup
// information, in the format
// `projects/{project_number}/locations/{location}`. In Filestore, backup
// locations map to Google Cloud regions, for example **us-west1**. To
// retrieve backup information for all locations, use "-" for the
// `{location}` value.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of items to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The next_page_token value to use if there are additional
// results to retrieve for this list request.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Sort results. Supported values are "name", "name desc" or "" (unsorted).
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// List filter.
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}ListBackupsRequest lists backups.
func (*ListBackupsRequest) Descriptor
func (*ListBackupsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.
func (*ListBackupsRequest) GetFilter
func (x *ListBackupsRequest) GetFilter() stringfunc (*ListBackupsRequest) GetOrderBy
func (x *ListBackupsRequest) GetOrderBy() stringfunc (*ListBackupsRequest) GetPageSize
func (x *ListBackupsRequest) GetPageSize() int32func (*ListBackupsRequest) GetPageToken
func (x *ListBackupsRequest) GetPageToken() stringfunc (*ListBackupsRequest) GetParent
func (x *ListBackupsRequest) GetParent() stringfunc (*ListBackupsRequest) ProtoMessage
func (*ListBackupsRequest) ProtoMessage()func (*ListBackupsRequest) ProtoReflect
func (x *ListBackupsRequest) ProtoReflect() protoreflect.Messagefunc (*ListBackupsRequest) Reset
func (x *ListBackupsRequest) Reset()func (*ListBackupsRequest) String
func (x *ListBackupsRequest) String() stringListBackupsResponse
type ListBackupsResponse struct {
// 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 `protobuf:"bytes,1,rep,name=backups,proto3" json:"backups,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Unordered list. Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}ListBackupsResponse is the result of ListBackupsRequest.
func (*ListBackupsResponse) Descriptor
func (*ListBackupsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.
func (*ListBackupsResponse) GetBackups
func (x *ListBackupsResponse) GetBackups() []*Backupfunc (*ListBackupsResponse) GetNextPageToken
func (x *ListBackupsResponse) GetNextPageToken() stringfunc (*ListBackupsResponse) GetUnreachable
func (x *ListBackupsResponse) GetUnreachable() []stringfunc (*ListBackupsResponse) ProtoMessage
func (*ListBackupsResponse) ProtoMessage()func (*ListBackupsResponse) ProtoReflect
func (x *ListBackupsResponse) ProtoReflect() protoreflect.Messagefunc (*ListBackupsResponse) Reset
func (x *ListBackupsResponse) Reset()func (*ListBackupsResponse) String
func (x *ListBackupsResponse) String() stringListInstancesRequest
type ListInstancesRequest struct {
// Required. The project and location for which to retrieve instance
// information, in the format `projects/{project_id}/locations/{location}`. In
// Cloud Filestore, locations map to Google Cloud zones, for example
// **us-west1-b**. To retrieve instance information for all locations, use "-"
// for the
// `{location}` value.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of items to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The next_page_token value to use if there are additional
// results to retrieve for this list request.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Sort results. Supported values are "name", "name desc" or "" (unsorted).
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// List filter.
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}ListInstancesRequest lists instances.
func (*ListInstancesRequest) Descriptor
func (*ListInstancesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.
func (*ListInstancesRequest) GetFilter
func (x *ListInstancesRequest) GetFilter() stringfunc (*ListInstancesRequest) GetOrderBy
func (x *ListInstancesRequest) GetOrderBy() stringfunc (*ListInstancesRequest) GetPageSize
func (x *ListInstancesRequest) GetPageSize() int32func (*ListInstancesRequest) GetPageToken
func (x *ListInstancesRequest) GetPageToken() stringfunc (*ListInstancesRequest) GetParent
func (x *ListInstancesRequest) GetParent() stringfunc (*ListInstancesRequest) ProtoMessage
func (*ListInstancesRequest) ProtoMessage()func (*ListInstancesRequest) ProtoReflect
func (x *ListInstancesRequest) ProtoReflect() protoreflect.Messagefunc (*ListInstancesRequest) Reset
func (x *ListInstancesRequest) Reset()func (*ListInstancesRequest) String
func (x *ListInstancesRequest) String() stringListInstancesResponse
type ListInstancesResponse struct {
// 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 `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Unordered list. Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}ListInstancesResponse is the result of ListInstancesRequest.
func (*ListInstancesResponse) Descriptor
func (*ListInstancesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.
func (*ListInstancesResponse) GetInstances
func (x *ListInstancesResponse) GetInstances() []*Instancefunc (*ListInstancesResponse) GetNextPageToken
func (x *ListInstancesResponse) GetNextPageToken() stringfunc (*ListInstancesResponse) GetUnreachable
func (x *ListInstancesResponse) GetUnreachable() []stringfunc (*ListInstancesResponse) ProtoMessage
func (*ListInstancesResponse) ProtoMessage()func (*ListInstancesResponse) ProtoReflect
func (x *ListInstancesResponse) ProtoReflect() protoreflect.Messagefunc (*ListInstancesResponse) Reset
func (x *ListInstancesResponse) Reset()func (*ListInstancesResponse) String
func (x *ListInstancesResponse) String() stringListSnapshotsRequest
type ListSnapshotsRequest struct {
// Required. The instance for which to retrieve snapshot information,
// in the format
// `projects/{project_id}/locations/{location}/instances/{instance_id}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of items to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The next_page_token value to use if there are additional
// results to retrieve for this list request.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Sort results. Supported values are "name", "name desc" or "" (unsorted).
OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// List filter.
Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. If true, allow partial responses for multi-regional Aggregated
// List requests.
ReturnPartialSuccess bool `protobuf:"varint,6,opt,name=return_partial_success,json=returnPartialSuccess,proto3" json:"return_partial_success,omitempty"`
// contains filtered or unexported fields
}ListSnapshotsRequest lists snapshots.
func (*ListSnapshotsRequest) Descriptor
func (*ListSnapshotsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSnapshotsRequest.ProtoReflect.Descriptor instead.
func (*ListSnapshotsRequest) GetFilter
func (x *ListSnapshotsRequest) GetFilter() stringfunc (*ListSnapshotsRequest) GetOrderBy
func (x *ListSnapshotsRequest) GetOrderBy() stringfunc (*ListSnapshotsRequest) GetPageSize
func (x *ListSnapshotsRequest) GetPageSize() int32func (*ListSnapshotsRequest) GetPageToken
func (x *ListSnapshotsRequest) GetPageToken() stringfunc (*ListSnapshotsRequest) GetParent
func (x *ListSnapshotsRequest) GetParent() stringfunc (*ListSnapshotsRequest) GetReturnPartialSuccess
func (x *ListSnapshotsRequest) GetReturnPartialSuccess() boolfunc (*ListSnapshotsRequest) ProtoMessage
func (*ListSnapshotsRequest) ProtoMessage()func (*ListSnapshotsRequest) ProtoReflect
func (x *ListSnapshotsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSnapshotsRequest) Reset
func (x *ListSnapshotsRequest) Reset()func (*ListSnapshotsRequest) String
func (x *ListSnapshotsRequest) String() stringListSnapshotsResponse
type ListSnapshotsResponse struct {
// A list of snapshots in the project for the specified instance.
Snapshots []*Snapshot `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Unordered list. Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}ListSnapshotsResponse is the result of ListSnapshotsRequest.
func (*ListSnapshotsResponse) Descriptor
func (*ListSnapshotsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSnapshotsResponse.ProtoReflect.Descriptor instead.
func (*ListSnapshotsResponse) GetNextPageToken
func (x *ListSnapshotsResponse) GetNextPageToken() stringfunc (*ListSnapshotsResponse) GetSnapshots
func (x *ListSnapshotsResponse) GetSnapshots() []*Snapshotfunc (*ListSnapshotsResponse) GetUnreachable
func (x *ListSnapshotsResponse) GetUnreachable() []stringfunc (*ListSnapshotsResponse) ProtoMessage
func (*ListSnapshotsResponse) ProtoMessage()func (*ListSnapshotsResponse) ProtoReflect
func (x *ListSnapshotsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSnapshotsResponse) Reset
func (x *ListSnapshotsResponse) Reset()func (*ListSnapshotsResponse) String
func (x *ListSnapshotsResponse) String() stringNetworkConfig
type NetworkConfig struct {
// The name of the Google Compute Engine
// [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
// instance is connected.
Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
// Internet protocol versions for which the instance has IP addresses
// assigned. For this version, only MODE_IPV4 is supported.
Modes []NetworkConfig_AddressMode `protobuf:"varint,3,rep,packed,name=modes,proto3,enum=google.cloud.filestore.v1.NetworkConfig_AddressMode" json:"modes,omitempty"`
// 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 `protobuf:"bytes,4,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`
// 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 `protobuf:"bytes,5,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty"`
// The network connect mode of the Filestore instance.
// If not provided, the connect mode defaults to DIRECT_PEERING.
ConnectMode NetworkConfig_ConnectMode `protobuf:"varint,6,opt,name=connect_mode,json=connectMode,proto3,enum=google.cloud.filestore.v1.NetworkConfig_ConnectMode" json:"connect_mode,omitempty"`
// contains filtered or unexported fields
}Network configuration for the instance.
func (*NetworkConfig) Descriptor
func (*NetworkConfig) Descriptor() ([]byte, []int)Deprecated: Use NetworkConfig.ProtoReflect.Descriptor instead.
func (*NetworkConfig) GetConnectMode
func (x *NetworkConfig) GetConnectMode() NetworkConfig_ConnectModefunc (*NetworkConfig) GetIpAddresses
func (x *NetworkConfig) GetIpAddresses() []stringfunc (*NetworkConfig) GetModes
func (x *NetworkConfig) GetModes() []NetworkConfig_AddressModefunc (*NetworkConfig) GetNetwork
func (x *NetworkConfig) GetNetwork() stringfunc (*NetworkConfig) GetReservedIpRange
func (x *NetworkConfig) GetReservedIpRange() stringfunc (*NetworkConfig) ProtoMessage
func (*NetworkConfig) ProtoMessage()func (*NetworkConfig) ProtoReflect
func (x *NetworkConfig) ProtoReflect() protoreflect.Messagefunc (*NetworkConfig) Reset
func (x *NetworkConfig) Reset()func (*NetworkConfig) String
func (x *NetworkConfig) String() stringNetworkConfig_AddressMode
type NetworkConfig_AddressMode int32Internet protocol versions supported by Filestore.
NetworkConfig_ADDRESS_MODE_UNSPECIFIED, NetworkConfig_MODE_IPV4
const (
// Internet protocol not set.
NetworkConfig_ADDRESS_MODE_UNSPECIFIED NetworkConfig_AddressMode = 0
// Use the IPv4 internet protocol.
NetworkConfig_MODE_IPV4 NetworkConfig_AddressMode = 1
)func (NetworkConfig_AddressMode) Descriptor
func (NetworkConfig_AddressMode) Descriptor() protoreflect.EnumDescriptorfunc (NetworkConfig_AddressMode) Enum
func (x NetworkConfig_AddressMode) Enum() *NetworkConfig_AddressModefunc (NetworkConfig_AddressMode) EnumDescriptor
func (NetworkConfig_AddressMode) EnumDescriptor() ([]byte, []int)Deprecated: Use NetworkConfig_AddressMode.Descriptor instead.
func (NetworkConfig_AddressMode) Number
func (x NetworkConfig_AddressMode) Number() protoreflect.EnumNumberfunc (NetworkConfig_AddressMode) String
func (x NetworkConfig_AddressMode) String() stringfunc (NetworkConfig_AddressMode) Type
func (NetworkConfig_AddressMode) Type() protoreflect.EnumTypeNetworkConfig_ConnectMode
type NetworkConfig_ConnectMode int32Available connection modes.
NetworkConfig_CONNECT_MODE_UNSPECIFIED, NetworkConfig_DIRECT_PEERING, NetworkConfig_PRIVATE_SERVICE_ACCESS
const (
// Not set.
NetworkConfig_CONNECT_MODE_UNSPECIFIED NetworkConfig_ConnectMode = 0
// Connect via direct peering to the Filestore service.
NetworkConfig_DIRECT_PEERING NetworkConfig_ConnectMode = 1
// Connect to your Filestore instance using Private Service
// Access. Private services access provides an IP address range for multiple
// Google Cloud services, including Filestore.
NetworkConfig_PRIVATE_SERVICE_ACCESS NetworkConfig_ConnectMode = 2
)func (NetworkConfig_ConnectMode) Descriptor
func (NetworkConfig_ConnectMode) Descriptor() protoreflect.EnumDescriptorfunc (NetworkConfig_ConnectMode) Enum
func (x NetworkConfig_ConnectMode) Enum() *NetworkConfig_ConnectModefunc (NetworkConfig_ConnectMode) EnumDescriptor
func (NetworkConfig_ConnectMode) EnumDescriptor() ([]byte, []int)Deprecated: Use NetworkConfig_ConnectMode.Descriptor instead.
func (NetworkConfig_ConnectMode) Number
func (x NetworkConfig_ConnectMode) Number() protoreflect.EnumNumberfunc (NetworkConfig_ConnectMode) String
func (x NetworkConfig_ConnectMode) String() stringfunc (NetworkConfig_ConnectMode) Type
func (NetworkConfig_ConnectMode) Type() protoreflect.EnumTypeNfsExportOptions
type NfsExportOptions struct {
// 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 `protobuf:"bytes,1,rep,name=ip_ranges,json=ipRanges,proto3" json:"ip_ranges,omitempty"`
// 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.
AccessMode NfsExportOptions_AccessMode `protobuf:"varint,2,opt,name=access_mode,json=accessMode,proto3,enum=google.cloud.filestore.v1.NfsExportOptions_AccessMode" json:"access_mode,omitempty"`
// 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.
SquashMode NfsExportOptions_SquashMode `protobuf:"varint,3,opt,name=squash_mode,json=squashMode,proto3,enum=google.cloud.filestore.v1.NfsExportOptions_SquashMode" json:"squash_mode,omitempty"`
// 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 `protobuf:"varint,4,opt,name=anon_uid,json=anonUid,proto3" json:"anon_uid,omitempty"`
// 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 `protobuf:"varint,5,opt,name=anon_gid,json=anonGid,proto3" json:"anon_gid,omitempty"`
// contains filtered or unexported fields
}NFS export options specifications.
func (*NfsExportOptions) Descriptor
func (*NfsExportOptions) Descriptor() ([]byte, []int)Deprecated: Use NfsExportOptions.ProtoReflect.Descriptor instead.
func (*NfsExportOptions) GetAccessMode
func (x *NfsExportOptions) GetAccessMode() NfsExportOptions_AccessModefunc (*NfsExportOptions) GetAnonGid
func (x *NfsExportOptions) GetAnonGid() int64func (*NfsExportOptions) GetAnonUid
func (x *NfsExportOptions) GetAnonUid() int64func (*NfsExportOptions) GetIpRanges
func (x *NfsExportOptions) GetIpRanges() []stringfunc (*NfsExportOptions) GetSquashMode
func (x *NfsExportOptions) GetSquashMode() NfsExportOptions_SquashModefunc (*NfsExportOptions) ProtoMessage
func (*NfsExportOptions) ProtoMessage()func (*NfsExportOptions) ProtoReflect
func (x *NfsExportOptions) ProtoReflect() protoreflect.Messagefunc (*NfsExportOptions) Reset
func (x *NfsExportOptions) Reset()func (*NfsExportOptions) String
func (x *NfsExportOptions) String() stringNfsExportOptions_AccessMode
type NfsExportOptions_AccessMode int32The access mode.
NfsExportOptions_ACCESS_MODE_UNSPECIFIED, NfsExportOptions_READ_ONLY, NfsExportOptions_READ_WRITE
const (
// AccessMode not set.
NfsExportOptions_ACCESS_MODE_UNSPECIFIED NfsExportOptions_AccessMode = 0
// The client can only read the file share.
NfsExportOptions_READ_ONLY NfsExportOptions_AccessMode = 1
// The client can read and write the file share (default).
NfsExportOptions_READ_WRITE NfsExportOptions_AccessMode = 2
)func (NfsExportOptions_AccessMode) Descriptor
func (NfsExportOptions_AccessMode) Descriptor() protoreflect.EnumDescriptorfunc (NfsExportOptions_AccessMode) Enum
func (x NfsExportOptions_AccessMode) Enum() *NfsExportOptions_AccessModefunc (NfsExportOptions_AccessMode) EnumDescriptor
func (NfsExportOptions_AccessMode) EnumDescriptor() ([]byte, []int)Deprecated: Use NfsExportOptions_AccessMode.Descriptor instead.
func (NfsExportOptions_AccessMode) Number
func (x NfsExportOptions_AccessMode) Number() protoreflect.EnumNumberfunc (NfsExportOptions_AccessMode) String
func (x NfsExportOptions_AccessMode) String() stringfunc (NfsExportOptions_AccessMode) Type
func (NfsExportOptions_AccessMode) Type() protoreflect.EnumTypeNfsExportOptions_SquashMode
type NfsExportOptions_SquashMode int32The squash mode.
NfsExportOptions_SQUASH_MODE_UNSPECIFIED, NfsExportOptions_NO_ROOT_SQUASH, NfsExportOptions_ROOT_SQUASH
const (
// SquashMode not set.
NfsExportOptions_SQUASH_MODE_UNSPECIFIED NfsExportOptions_SquashMode = 0
// The Root user has root access to the file share (default).
NfsExportOptions_NO_ROOT_SQUASH NfsExportOptions_SquashMode = 1
// The Root user has squashed access to the anonymous uid/gid.
NfsExportOptions_ROOT_SQUASH NfsExportOptions_SquashMode = 2
)func (NfsExportOptions_SquashMode) Descriptor
func (NfsExportOptions_SquashMode) Descriptor() protoreflect.EnumDescriptorfunc (NfsExportOptions_SquashMode) Enum
func (x NfsExportOptions_SquashMode) Enum() *NfsExportOptions_SquashModefunc (NfsExportOptions_SquashMode) EnumDescriptor
func (NfsExportOptions_SquashMode) EnumDescriptor() ([]byte, []int)Deprecated: Use NfsExportOptions_SquashMode.Descriptor instead.
func (NfsExportOptions_SquashMode) Number
func (x NfsExportOptions_SquashMode) Number() protoreflect.EnumNumberfunc (NfsExportOptions_SquashMode) String
func (x NfsExportOptions_SquashMode) String() stringfunc (NfsExportOptions_SquashMode) Type
func (NfsExportOptions_SquashMode) Type() protoreflect.EnumTypePromoteReplicaRequest
type PromoteReplicaRequest struct {
// Required. The resource name of the instance, in the format
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The resource name of the peer instance to promote, in the format
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
// The peer instance is required if the operation is called on an active
// instance.
PeerInstance string `protobuf:"bytes,2,opt,name=peer_instance,json=peerInstance,proto3" json:"peer_instance,omitempty"`
// contains filtered or unexported fields
}PromoteReplicaRequest promotes a Filestore standby instance (replica).
func (*PromoteReplicaRequest) Descriptor
func (*PromoteReplicaRequest) Descriptor() ([]byte, []int)Deprecated: Use PromoteReplicaRequest.ProtoReflect.Descriptor instead.
func (*PromoteReplicaRequest) GetName
func (x *PromoteReplicaRequest) GetName() stringfunc (*PromoteReplicaRequest) GetPeerInstance
func (x *PromoteReplicaRequest) GetPeerInstance() stringfunc (*PromoteReplicaRequest) ProtoMessage
func (*PromoteReplicaRequest) ProtoMessage()func (*PromoteReplicaRequest) ProtoReflect
func (x *PromoteReplicaRequest) ProtoReflect() protoreflect.Messagefunc (*PromoteReplicaRequest) Reset
func (x *PromoteReplicaRequest) Reset()func (*PromoteReplicaRequest) String
func (x *PromoteReplicaRequest) String() stringReplicaConfig
type ReplicaConfig struct {
// Output only. The replica state.
State ReplicaConfig_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.filestore.v1.ReplicaConfig_State" json:"state,omitempty"`
// Output only. Additional information about the replication state, if
// available.
StateReasons []ReplicaConfig_StateReason `protobuf:"varint,2,rep,packed,name=state_reasons,json=stateReasons,proto3,enum=google.cloud.filestore.v1.ReplicaConfig_StateReason" json:"state_reasons,omitempty"`
// Optional. The peer instance.
PeerInstance string `protobuf:"bytes,3,opt,name=peer_instance,json=peerInstance,proto3" json:"peer_instance,omitempty"`
// Output only. The timestamp of the latest replication snapshot taken on the
// active instance and is already replicated safely.
LastActiveSyncTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=last_active_sync_time,json=lastActiveSyncTime,proto3" json:"last_active_sync_time,omitempty"`
// contains filtered or unexported fields
}Replica configuration for the instance.
func (*ReplicaConfig) Descriptor
func (*ReplicaConfig) Descriptor() ([]byte, []int)Deprecated: Use ReplicaConfig.ProtoReflect.Descriptor instead.
func (*ReplicaConfig) GetLastActiveSyncTime
func (x *ReplicaConfig) GetLastActiveSyncTime() *timestamppb.Timestampfunc (*ReplicaConfig) GetPeerInstance
func (x *ReplicaConfig) GetPeerInstance() stringfunc (*ReplicaConfig) GetState
func (x *ReplicaConfig) GetState() ReplicaConfig_Statefunc (*ReplicaConfig) GetStateReasons
func (x *ReplicaConfig) GetStateReasons() []ReplicaConfig_StateReasonfunc (*ReplicaConfig) ProtoMessage
func (*ReplicaConfig) ProtoMessage()func (*ReplicaConfig) ProtoReflect
func (x *ReplicaConfig) ProtoReflect() protoreflect.Messagefunc (*ReplicaConfig) Reset
func (x *ReplicaConfig) Reset()func (*ReplicaConfig) String
func (x *ReplicaConfig) String() stringReplicaConfig_State
type ReplicaConfig_State int32The replica state.
ReplicaConfig_STATE_UNSPECIFIED, ReplicaConfig_CREATING, ReplicaConfig_READY, ReplicaConfig_REMOVING, ReplicaConfig_FAILED
const (
// State not set.
ReplicaConfig_STATE_UNSPECIFIED ReplicaConfig_State = 0
// The replica is being created.
ReplicaConfig_CREATING ReplicaConfig_State = 1
// The replica is ready.
ReplicaConfig_READY ReplicaConfig_State = 3
// The replica is being removed.
ReplicaConfig_REMOVING ReplicaConfig_State = 4
// The replica is experiencing an issue and might be unusable. You can get
// further details from the `stateReasons` field of the `ReplicaConfig`
// object.
ReplicaConfig_FAILED ReplicaConfig_State = 5
)func (ReplicaConfig_State) Descriptor
func (ReplicaConfig_State) Descriptor() protoreflect.EnumDescriptorfunc (ReplicaConfig_State) Enum
func (x ReplicaConfig_State) Enum() *ReplicaConfig_Statefunc (ReplicaConfig_State) EnumDescriptor
func (ReplicaConfig_State) EnumDescriptor() ([]byte, []int)Deprecated: Use ReplicaConfig_State.Descriptor instead.
func (ReplicaConfig_State) Number
func (x ReplicaConfig_State) Number() protoreflect.EnumNumberfunc (ReplicaConfig_State) String
func (x ReplicaConfig_State) String() stringfunc (ReplicaConfig_State) Type
func (ReplicaConfig_State) Type() protoreflect.EnumTypeReplicaConfig_StateReason
type ReplicaConfig_StateReason int32Additional information about the replication state, if available.
ReplicaConfig_STATE_REASON_UNSPECIFIED, ReplicaConfig_PEER_INSTANCE_UNREACHABLE, ReplicaConfig_REMOVE_FAILED
const (
// Reason not specified.
ReplicaConfig_STATE_REASON_UNSPECIFIED ReplicaConfig_StateReason = 0
// The peer instance is unreachable.
ReplicaConfig_PEER_INSTANCE_UNREACHABLE ReplicaConfig_StateReason = 1
// The remove replica peer instance operation failed.
ReplicaConfig_REMOVE_FAILED ReplicaConfig_StateReason = 2
)func (ReplicaConfig_StateReason) Descriptor
func (ReplicaConfig_StateReason) Descriptor() protoreflect.EnumDescriptorfunc (ReplicaConfig_StateReason) Enum
func (x ReplicaConfig_StateReason) Enum() *ReplicaConfig_StateReasonfunc (ReplicaConfig_StateReason) EnumDescriptor
func (ReplicaConfig_StateReason) EnumDescriptor() ([]byte, []int)Deprecated: Use ReplicaConfig_StateReason.Descriptor instead.
func (ReplicaConfig_StateReason) Number
func (x ReplicaConfig_StateReason) Number() protoreflect.EnumNumberfunc (ReplicaConfig_StateReason) String
func (x ReplicaConfig_StateReason) String() stringfunc (ReplicaConfig_StateReason) Type
func (ReplicaConfig_StateReason) Type() protoreflect.EnumTypeReplication
type Replication struct {
// Optional. The replication role.
Role Replication_Role `protobuf:"varint,1,opt,name=role,proto3,enum=google.cloud.filestore.v1.Replication_Role" json:"role,omitempty"`
// Optional. Replication configuration for the replica instance associated
// with this instance. Only a single replica is supported.
Replicas []*ReplicaConfig `protobuf:"bytes,2,rep,name=replicas,proto3" json:"replicas,omitempty"`
// contains filtered or unexported fields
}Replication specifications.
func (*Replication) Descriptor
func (*Replication) Descriptor() ([]byte, []int)Deprecated: Use Replication.ProtoReflect.Descriptor instead.
func (*Replication) GetReplicas
func (x *Replication) GetReplicas() []*ReplicaConfigfunc (*Replication) GetRole
func (x *Replication) GetRole() Replication_Rolefunc (*Replication) ProtoMessage
func (*Replication) ProtoMessage()func (*Replication) ProtoReflect
func (x *Replication) ProtoReflect() protoreflect.Messagefunc (*Replication) Reset
func (x *Replication) Reset()func (*Replication) String
func (x *Replication) String() stringReplication_Role
type Replication_Role int32Replication role.
Replication_ROLE_UNSPECIFIED, Replication_ACTIVE, Replication_STANDBY
const (
// Role not set.
Replication_ROLE_UNSPECIFIED Replication_Role = 0
// The instance is the `ACTIVE` replication member, functions as
// the replication source instance.
Replication_ACTIVE Replication_Role = 1
// The instance is the `STANDBY` replication member, functions as
// the replication destination instance.
Replication_STANDBY Replication_Role = 2
)func (Replication_Role) Descriptor
func (Replication_Role) Descriptor() protoreflect.EnumDescriptorfunc (Replication_Role) Enum
func (x Replication_Role) Enum() *Replication_Rolefunc (Replication_Role) EnumDescriptor
func (Replication_Role) EnumDescriptor() ([]byte, []int)Deprecated: Use Replication_Role.Descriptor instead.
func (Replication_Role) Number
func (x Replication_Role) Number() protoreflect.EnumNumberfunc (Replication_Role) String
func (x Replication_Role) String() stringfunc (Replication_Role) Type
func (Replication_Role) Type() protoreflect.EnumTypeRestoreInstanceRequest
type RestoreInstanceRequest struct {
// Required. The resource name of the instance, in the format
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Name of the file share in the Filestore instance that the backup
// is being restored to.
FileShare string `protobuf:"bytes,2,opt,name=file_share,json=fileShare,proto3" json:"file_share,omitempty"`
// Types that are assignable to Source:
//
// *RestoreInstanceRequest_SourceBackup
Source isRestoreInstanceRequest_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}RestoreInstanceRequest restores an existing instance's file share from a backup.
func (*RestoreInstanceRequest) Descriptor
func (*RestoreInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use RestoreInstanceRequest.ProtoReflect.Descriptor instead.
func (*RestoreInstanceRequest) GetFileShare
func (x *RestoreInstanceRequest) GetFileShare() stringfunc (*RestoreInstanceRequest) GetName
func (x *RestoreInstanceRequest) GetName() stringfunc (*RestoreInstanceRequest) GetSource
func (m *RestoreInstanceRequest) GetSource() isRestoreInstanceRequest_Sourcefunc (*RestoreInstanceRequest) GetSourceBackup
func (x *RestoreInstanceRequest) GetSourceBackup() stringfunc (*RestoreInstanceRequest) ProtoMessage
func (*RestoreInstanceRequest) ProtoMessage()func (*RestoreInstanceRequest) ProtoReflect
func (x *RestoreInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*RestoreInstanceRequest) Reset
func (x *RestoreInstanceRequest) Reset()func (*RestoreInstanceRequest) String
func (x *RestoreInstanceRequest) String() stringRestoreInstanceRequest_SourceBackup
type RestoreInstanceRequest_SourceBackup struct {
// The resource name of the backup, in the format
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
SourceBackup string `protobuf:"bytes,3,opt,name=source_backup,json=sourceBackup,proto3,oneof"`
}RevertInstanceRequest
type RevertInstanceRequest struct {
// Required. The resource name of the instance, in the format
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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}/snapshots/{snapshot_id}`
TargetSnapshotId string `protobuf:"bytes,2,opt,name=target_snapshot_id,json=targetSnapshotId,proto3" json:"target_snapshot_id,omitempty"`
// contains filtered or unexported fields
}RevertInstanceRequest reverts the given instance's file share to the specified snapshot.
func (*RevertInstanceRequest) Descriptor
func (*RevertInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use RevertInstanceRequest.ProtoReflect.Descriptor instead.
func (*RevertInstanceRequest) GetName
func (x *RevertInstanceRequest) GetName() stringfunc (*RevertInstanceRequest) GetTargetSnapshotId
func (x *RevertInstanceRequest) GetTargetSnapshotId() stringfunc (*RevertInstanceRequest) ProtoMessage
func (*RevertInstanceRequest) ProtoMessage()func (*RevertInstanceRequest) ProtoReflect
func (x *RevertInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*RevertInstanceRequest) Reset
func (x *RevertInstanceRequest) Reset()func (*RevertInstanceRequest) String
func (x *RevertInstanceRequest) String() stringSnapshot
type Snapshot struct {
// Output only. The resource name of the snapshot, in the format
// `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// A description of the snapshot with 2048 characters or less.
// Requests with longer descriptions will be rejected.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The snapshot state.
State Snapshot_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.filestore.v1.Snapshot_State" json:"state,omitempty"`
// Output only. The time when the snapshot was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Resource labels to represent user provided metadata.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. The amount of bytes needed to allocate a full copy of the
// snapshot content
FilesystemUsedBytes int64 `protobuf:"varint,6,opt,name=filesystem_used_bytes,json=filesystemUsedBytes,proto3" json:"filesystem_used_bytes,omitempty"`
// Optional. Input only. Immutable. Tag key-value pairs bound to this
// resource. Each key must be a namespaced name and each value a short name.
// Example:
// "123456789012/environment" : "production",
// "123456789013/costCenter" : "marketing"
// See the documentation for more information:
// - Namespaced name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
// - Short name:
// https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
Tags map[string]string `protobuf:"bytes,7,rep,name=tags,proto3" json:"tags,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}A Filestore snapshot.
func (*Snapshot) Descriptor
Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.
func (*Snapshot) GetCreateTime
func (x *Snapshot) GetCreateTime() *timestamppb.Timestampfunc (*Snapshot) GetDescription
func (*Snapshot) GetFilesystemUsedBytes
func (*Snapshot) GetLabels
func (*Snapshot) GetName
func (*Snapshot) GetState
func (x *Snapshot) GetState() Snapshot_Statefunc (*Snapshot) GetTags
func (*Snapshot) ProtoMessage
func (*Snapshot) ProtoMessage()func (*Snapshot) ProtoReflect
func (x *Snapshot) ProtoReflect() protoreflect.Messagefunc (*Snapshot) Reset
func (x *Snapshot) Reset()func (*Snapshot) String
Snapshot_State
type Snapshot_State int32The snapshot state.
Snapshot_STATE_UNSPECIFIED, Snapshot_CREATING, Snapshot_READY, Snapshot_DELETING
const (
// State not set.
Snapshot_STATE_UNSPECIFIED Snapshot_State = 0
// Snapshot is being created.
Snapshot_CREATING Snapshot_State = 1
// Snapshot is available for use.
Snapshot_READY Snapshot_State = 2
// Snapshot is being deleted.
Snapshot_DELETING Snapshot_State = 3
)func (Snapshot_State) Descriptor
func (Snapshot_State) Descriptor() protoreflect.EnumDescriptorfunc (Snapshot_State) Enum
func (x Snapshot_State) Enum() *Snapshot_Statefunc (Snapshot_State) EnumDescriptor
func (Snapshot_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Snapshot_State.Descriptor instead.
func (Snapshot_State) Number
func (x Snapshot_State) Number() protoreflect.EnumNumberfunc (Snapshot_State) String
func (x Snapshot_State) String() stringfunc (Snapshot_State) Type
func (Snapshot_State) Type() protoreflect.EnumTypeUnimplementedCloudFilestoreManagerServer
type UnimplementedCloudFilestoreManagerServer struct {
}UnimplementedCloudFilestoreManagerServer should be embedded to have forward compatible implementations.
func (UnimplementedCloudFilestoreManagerServer) CreateBackup
func (UnimplementedCloudFilestoreManagerServer) CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) CreateInstance
func (UnimplementedCloudFilestoreManagerServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) CreateSnapshot
func (UnimplementedCloudFilestoreManagerServer) CreateSnapshot(context.Context, *CreateSnapshotRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) DeleteBackup
func (UnimplementedCloudFilestoreManagerServer) DeleteBackup(context.Context, *DeleteBackupRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) DeleteInstance
func (UnimplementedCloudFilestoreManagerServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) DeleteSnapshot
func (UnimplementedCloudFilestoreManagerServer) DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) GetBackup
func (UnimplementedCloudFilestoreManagerServer) GetBackup(context.Context, *GetBackupRequest) (*Backup, error)func (UnimplementedCloudFilestoreManagerServer) GetInstance
func (UnimplementedCloudFilestoreManagerServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)func (UnimplementedCloudFilestoreManagerServer) GetSnapshot
func (UnimplementedCloudFilestoreManagerServer) GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)func (UnimplementedCloudFilestoreManagerServer) ListBackups
func (UnimplementedCloudFilestoreManagerServer) ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)func (UnimplementedCloudFilestoreManagerServer) ListInstances
func (UnimplementedCloudFilestoreManagerServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)func (UnimplementedCloudFilestoreManagerServer) ListSnapshots
func (UnimplementedCloudFilestoreManagerServer) ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)func (UnimplementedCloudFilestoreManagerServer) PromoteReplica
func (UnimplementedCloudFilestoreManagerServer) PromoteReplica(context.Context, *PromoteReplicaRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) RestoreInstance
func (UnimplementedCloudFilestoreManagerServer) RestoreInstance(context.Context, *RestoreInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) RevertInstance
func (UnimplementedCloudFilestoreManagerServer) RevertInstance(context.Context, *RevertInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) UpdateBackup
func (UnimplementedCloudFilestoreManagerServer) UpdateBackup(context.Context, *UpdateBackupRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) UpdateInstance
func (UnimplementedCloudFilestoreManagerServer) UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)func (UnimplementedCloudFilestoreManagerServer) UpdateSnapshot
func (UnimplementedCloudFilestoreManagerServer) UpdateSnapshot(context.Context, *UpdateSnapshotRequest) (*longrunningpb.Operation, error)UnsafeCloudFilestoreManagerServer
type UnsafeCloudFilestoreManagerServer interface {
// contains filtered or unexported methods
}UnsafeCloudFilestoreManagerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CloudFilestoreManagerServer will result in compilation errors.
UpdateBackupRequest
type UpdateBackupRequest struct {
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
Backup *Backup `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
// Required. Mask of fields to update. At least one path must be supplied in
// this field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}UpdateBackupRequest updates description and/or labels for a backup.
func (*UpdateBackupRequest) Descriptor
func (*UpdateBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateBackupRequest.ProtoReflect.Descriptor instead.
func (*UpdateBackupRequest) GetBackup
func (x *UpdateBackupRequest) GetBackup() *Backupfunc (*UpdateBackupRequest) GetUpdateMask
func (x *UpdateBackupRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateBackupRequest) ProtoMessage
func (*UpdateBackupRequest) ProtoMessage()func (*UpdateBackupRequest) ProtoReflect
func (x *UpdateBackupRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateBackupRequest) Reset
func (x *UpdateBackupRequest) Reset()func (*UpdateBackupRequest) String
func (x *UpdateBackupRequest) String() stringUpdateInstanceRequest
type UpdateInstanceRequest struct {
// Mask of fields to update. At least one path must be supplied in this
// field. The elements of the repeated paths field may only include these
// fields:
//
// * "description"
// * "file_shares"
// * "labels"
// * "performance_config"
// * "deletion_protection_enabled"
// * "deletion_protection_reason"
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Only fields specified in update_mask are updated.
Instance *Instance `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
// contains filtered or unexported fields
}UpdateInstanceRequest updates the settings of an instance.
func (*UpdateInstanceRequest) Descriptor
func (*UpdateInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.
func (*UpdateInstanceRequest) GetInstance
func (x *UpdateInstanceRequest) GetInstance() *Instancefunc (*UpdateInstanceRequest) GetUpdateMask
func (x *UpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateInstanceRequest) ProtoMessage
func (*UpdateInstanceRequest) ProtoMessage()func (*UpdateInstanceRequest) ProtoReflect
func (x *UpdateInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateInstanceRequest) Reset
func (x *UpdateInstanceRequest) Reset()func (*UpdateInstanceRequest) String
func (x *UpdateInstanceRequest) String() stringUpdateSnapshotRequest
type UpdateSnapshotRequest struct {
// Required. Mask of fields to update. At least one path must be supplied in
// this field.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Required. A snapshot resource.
Snapshot *Snapshot `protobuf:"bytes,2,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
// contains filtered or unexported fields
}UpdateSnapshotRequest updates description and/or labels for a snapshot.
func (*UpdateSnapshotRequest) Descriptor
func (*UpdateSnapshotRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateSnapshotRequest.ProtoReflect.Descriptor instead.
func (*UpdateSnapshotRequest) GetSnapshot
func (x *UpdateSnapshotRequest) GetSnapshot() *Snapshotfunc (*UpdateSnapshotRequest) GetUpdateMask
func (x *UpdateSnapshotRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateSnapshotRequest) ProtoMessage
func (*UpdateSnapshotRequest) ProtoMessage()func (*UpdateSnapshotRequest) ProtoReflect
func (x *UpdateSnapshotRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateSnapshotRequest) Reset
func (x *UpdateSnapshotRequest) Reset()func (*UpdateSnapshotRequest) String
func (x *UpdateSnapshotRequest) String() string