google-cloud-filestore-v1 0.3.0 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/client.rb +539 -20
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/operations.rb +2 -2
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/paths.rb +21 -0
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/rest/client.rb +399 -20
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/rest/operations.rb +2 -2
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/rest/service_stub.rb +297 -0
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager/rest.rb +6 -6
- data/lib/google/cloud/filestore/v1/cloud_filestore_manager.rb +6 -6
- data/lib/google/cloud/filestore/v1/cloud_filestore_service_pb.rb +69 -0
- data/lib/google/cloud/filestore/v1/cloud_filestore_service_services_pb.rb +17 -6
- data/lib/google/cloud/filestore/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +57 -3
- data/proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb +237 -29
- metadata +5 -4
@@ -79,6 +79,27 @@ module Google
|
|
79
79
|
"projects/#{project}/locations/#{location}"
|
80
80
|
end
|
81
81
|
|
82
|
+
##
|
83
|
+
# Create a fully-qualified Snapshot resource string.
|
84
|
+
#
|
85
|
+
# The resource will be in the following format:
|
86
|
+
#
|
87
|
+
# `projects/{project}/locations/{location}/instances/{instance}/snapshots/{snapshot}`
|
88
|
+
#
|
89
|
+
# @param project [String]
|
90
|
+
# @param location [String]
|
91
|
+
# @param instance [String]
|
92
|
+
# @param snapshot [String]
|
93
|
+
#
|
94
|
+
# @return [::String]
|
95
|
+
def snapshot_path project:, location:, instance:, snapshot:
|
96
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
97
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
98
|
+
raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"
|
99
|
+
|
100
|
+
"projects/#{project}/locations/#{location}/instances/#{instance}/snapshots/#{snapshot}"
|
101
|
+
end
|
102
|
+
|
82
103
|
extend self
|
83
104
|
end
|
84
105
|
end
|
@@ -29,23 +29,23 @@ module Google
|
|
29
29
|
##
|
30
30
|
# REST client for the CloudFilestoreManager service.
|
31
31
|
#
|
32
|
-
# Configures and manages
|
32
|
+
# Configures and manages Filestore resources.
|
33
33
|
#
|
34
|
-
#
|
34
|
+
# Filestore Manager v1.
|
35
35
|
#
|
36
|
-
# The `file.googleapis.com` service implements the
|
36
|
+
# The `file.googleapis.com` service implements the Filestore API and
|
37
37
|
# defines the following resource model for managing instances:
|
38
38
|
# * The service works with a collection of cloud projects, named: `/projects/*`
|
39
39
|
# * Each project has a collection of available locations, named: `/locations/*`
|
40
40
|
# * Each location has a collection of instances and backups, named:
|
41
41
|
# `/instances/*` and `/backups/*` respectively.
|
42
|
-
# * As such,
|
42
|
+
# * As such, Filestore instances are resources of the form:
|
43
43
|
# `/projects/{project_number}/locations/{location_id}/instances/{instance_id}`
|
44
44
|
# and backups are resources of the form:
|
45
45
|
# `/projects/{project_number}/locations/{location_id}/backup/{backup_id}`
|
46
46
|
#
|
47
|
-
# Note that location_id must be a
|
48
|
-
# `region` for backups; for example:
|
47
|
+
# Note that location_id must be a Google Cloud `zone` for instances, but
|
48
|
+
# a Google Cloud `region` for backups; for example:
|
49
49
|
# * `projects/12345/locations/us-central1-c/instances/my-filestore`
|
50
50
|
# * `projects/12345/locations/us-central1/backups/my-backup`
|
51
51
|
#
|
@@ -222,8 +222,9 @@ module Google
|
|
222
222
|
# @param parent [::String]
|
223
223
|
# Required. The project and location for which to retrieve instance
|
224
224
|
# information, in the format `projects/{project_id}/locations/{location}`. In
|
225
|
-
# Cloud Filestore, locations map to
|
226
|
-
# retrieve instance information for all locations, use "-"
|
225
|
+
# Cloud Filestore, locations map to Google Cloud zones, for example
|
226
|
+
# **us-west1-b**. To retrieve instance information for all locations, use "-"
|
227
|
+
# for the
|
227
228
|
# `{location}` value.
|
228
229
|
# @param page_size [::Integer]
|
229
230
|
# The maximum number of items to return.
|
@@ -362,8 +363,8 @@ module Google
|
|
362
363
|
#
|
363
364
|
# @param parent [::String]
|
364
365
|
# Required. The instance's project and location, in the format
|
365
|
-
# `projects/{project_id}/locations/{location}`. In
|
366
|
-
# locations map to
|
366
|
+
# `projects/{project_id}/locations/{location}`. In Filestore,
|
367
|
+
# locations map to Google Cloud zones, for example **us-west1-b**.
|
367
368
|
# @param instance_id [::String]
|
368
369
|
# Required. The name of the instance to create.
|
369
370
|
# The name must be unique for the specified project and location.
|
@@ -509,8 +510,8 @@ module Google
|
|
509
510
|
# Required. The resource name of the instance, in the format
|
510
511
|
# `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
|
511
512
|
# @param file_share [::String]
|
512
|
-
# Required. Name of the file share in the
|
513
|
-
#
|
513
|
+
# Required. Name of the file share in the Filestore instance that the backup
|
514
|
+
# is being restored to.
|
514
515
|
# @param source_backup [::String]
|
515
516
|
# The resource name of the backup, in the format
|
516
517
|
# `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
|
@@ -570,7 +571,7 @@ module Google
|
|
570
571
|
# @param options [::Gapic::CallOptions, ::Hash]
|
571
572
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
572
573
|
#
|
573
|
-
# @overload delete_instance(name: nil)
|
574
|
+
# @overload delete_instance(name: nil, force: nil)
|
574
575
|
# Pass arguments to `delete_instance` via keyword arguments. Note that at
|
575
576
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
576
577
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -578,6 +579,9 @@ module Google
|
|
578
579
|
# @param name [::String]
|
579
580
|
# Required. The instance resource name, in the format
|
580
581
|
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
582
|
+
# @param force [::Boolean]
|
583
|
+
# If set to true, all snapshots of the instance will also be deleted.
|
584
|
+
# (Otherwise, the request will only work if the instance has no snapshots.)
|
581
585
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
582
586
|
# @yieldparam result [::Gapic::Operation]
|
583
587
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -621,6 +625,346 @@ module Google
|
|
621
625
|
raise ::Google::Cloud::Error.from_error(e)
|
622
626
|
end
|
623
627
|
|
628
|
+
##
|
629
|
+
# Lists all snapshots in a project for either a specified location
|
630
|
+
# or for all locations.
|
631
|
+
#
|
632
|
+
# @overload list_snapshots(request, options = nil)
|
633
|
+
# Pass arguments to `list_snapshots` via a request object, either of type
|
634
|
+
# {::Google::Cloud::Filestore::V1::ListSnapshotsRequest} or an equivalent Hash.
|
635
|
+
#
|
636
|
+
# @param request [::Google::Cloud::Filestore::V1::ListSnapshotsRequest, ::Hash]
|
637
|
+
# A request object representing the call parameters. Required. To specify no
|
638
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
639
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
640
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
641
|
+
#
|
642
|
+
# @overload list_snapshots(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
|
643
|
+
# Pass arguments to `list_snapshots` via keyword arguments. Note that at
|
644
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
645
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
646
|
+
#
|
647
|
+
# @param parent [::String]
|
648
|
+
# Required. The instance for which to retrieve snapshot information,
|
649
|
+
# in the format
|
650
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`.
|
651
|
+
# @param page_size [::Integer]
|
652
|
+
# The maximum number of items to return.
|
653
|
+
# @param page_token [::String]
|
654
|
+
# The next_page_token value to use if there are additional
|
655
|
+
# results to retrieve for this list request.
|
656
|
+
# @param order_by [::String]
|
657
|
+
# Sort results. Supported values are "name", "name desc" or "" (unsorted).
|
658
|
+
# @param filter [::String]
|
659
|
+
# List filter.
|
660
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
661
|
+
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Filestore::V1::Snapshot>]
|
662
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
663
|
+
#
|
664
|
+
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Filestore::V1::Snapshot>]
|
665
|
+
#
|
666
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
667
|
+
def list_snapshots request, options = nil
|
668
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
669
|
+
|
670
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Filestore::V1::ListSnapshotsRequest
|
671
|
+
|
672
|
+
# Converts hash and nil to an options object
|
673
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
674
|
+
|
675
|
+
# Customize the options with defaults
|
676
|
+
call_metadata = @config.rpcs.list_snapshots.metadata.to_h
|
677
|
+
|
678
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
679
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
680
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
681
|
+
gapic_version: ::Google::Cloud::Filestore::V1::VERSION,
|
682
|
+
transports_version_send: [:rest]
|
683
|
+
|
684
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
685
|
+
|
686
|
+
options.apply_defaults timeout: @config.rpcs.list_snapshots.timeout,
|
687
|
+
metadata: call_metadata,
|
688
|
+
retry_policy: @config.rpcs.list_snapshots.retry_policy
|
689
|
+
|
690
|
+
options.apply_defaults timeout: @config.timeout,
|
691
|
+
metadata: @config.metadata,
|
692
|
+
retry_policy: @config.retry_policy
|
693
|
+
|
694
|
+
@cloud_filestore_manager_stub.list_snapshots request, options do |result, operation|
|
695
|
+
result = ::Gapic::Rest::PagedEnumerable.new @cloud_filestore_manager_stub, :list_snapshots, "snapshots", request, result, options
|
696
|
+
yield result, operation if block_given?
|
697
|
+
return result
|
698
|
+
end
|
699
|
+
rescue ::Gapic::Rest::Error => e
|
700
|
+
raise ::Google::Cloud::Error.from_error(e)
|
701
|
+
end
|
702
|
+
|
703
|
+
##
|
704
|
+
# Gets the details of a specific snapshot.
|
705
|
+
#
|
706
|
+
# @overload get_snapshot(request, options = nil)
|
707
|
+
# Pass arguments to `get_snapshot` via a request object, either of type
|
708
|
+
# {::Google::Cloud::Filestore::V1::GetSnapshotRequest} or an equivalent Hash.
|
709
|
+
#
|
710
|
+
# @param request [::Google::Cloud::Filestore::V1::GetSnapshotRequest, ::Hash]
|
711
|
+
# A request object representing the call parameters. Required. To specify no
|
712
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
713
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
714
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
715
|
+
#
|
716
|
+
# @overload get_snapshot(name: nil)
|
717
|
+
# Pass arguments to `get_snapshot` via keyword arguments. Note that at
|
718
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
719
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
720
|
+
#
|
721
|
+
# @param name [::String]
|
722
|
+
# Required. The snapshot resource name, in the format
|
723
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`
|
724
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
725
|
+
# @yieldparam result [::Google::Cloud::Filestore::V1::Snapshot]
|
726
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
727
|
+
#
|
728
|
+
# @return [::Google::Cloud::Filestore::V1::Snapshot]
|
729
|
+
#
|
730
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
731
|
+
def get_snapshot request, options = nil
|
732
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
733
|
+
|
734
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Filestore::V1::GetSnapshotRequest
|
735
|
+
|
736
|
+
# Converts hash and nil to an options object
|
737
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
738
|
+
|
739
|
+
# Customize the options with defaults
|
740
|
+
call_metadata = @config.rpcs.get_snapshot.metadata.to_h
|
741
|
+
|
742
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
743
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
744
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
745
|
+
gapic_version: ::Google::Cloud::Filestore::V1::VERSION,
|
746
|
+
transports_version_send: [:rest]
|
747
|
+
|
748
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
749
|
+
|
750
|
+
options.apply_defaults timeout: @config.rpcs.get_snapshot.timeout,
|
751
|
+
metadata: call_metadata,
|
752
|
+
retry_policy: @config.rpcs.get_snapshot.retry_policy
|
753
|
+
|
754
|
+
options.apply_defaults timeout: @config.timeout,
|
755
|
+
metadata: @config.metadata,
|
756
|
+
retry_policy: @config.retry_policy
|
757
|
+
|
758
|
+
@cloud_filestore_manager_stub.get_snapshot request, options do |result, operation|
|
759
|
+
yield result, operation if block_given?
|
760
|
+
return result
|
761
|
+
end
|
762
|
+
rescue ::Gapic::Rest::Error => e
|
763
|
+
raise ::Google::Cloud::Error.from_error(e)
|
764
|
+
end
|
765
|
+
|
766
|
+
##
|
767
|
+
# Creates a snapshot.
|
768
|
+
#
|
769
|
+
# @overload create_snapshot(request, options = nil)
|
770
|
+
# Pass arguments to `create_snapshot` via a request object, either of type
|
771
|
+
# {::Google::Cloud::Filestore::V1::CreateSnapshotRequest} or an equivalent Hash.
|
772
|
+
#
|
773
|
+
# @param request [::Google::Cloud::Filestore::V1::CreateSnapshotRequest, ::Hash]
|
774
|
+
# A request object representing the call parameters. Required. To specify no
|
775
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
776
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
777
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
778
|
+
#
|
779
|
+
# @overload create_snapshot(parent: nil, snapshot_id: nil, snapshot: nil)
|
780
|
+
# Pass arguments to `create_snapshot` via keyword arguments. Note that at
|
781
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
782
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
783
|
+
#
|
784
|
+
# @param parent [::String]
|
785
|
+
# Required. The Filestore Instance to create the snapshots of, in the format
|
786
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}`
|
787
|
+
# @param snapshot_id [::String]
|
788
|
+
# Required. The ID to use for the snapshot.
|
789
|
+
# The ID must be unique within the specified instance.
|
790
|
+
#
|
791
|
+
# This value must start with a lowercase letter followed by up to 62
|
792
|
+
# lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
|
793
|
+
# @param snapshot [::Google::Cloud::Filestore::V1::Snapshot, ::Hash]
|
794
|
+
# Required. A snapshot resource.
|
795
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
796
|
+
# @yieldparam result [::Gapic::Operation]
|
797
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
798
|
+
#
|
799
|
+
# @return [::Gapic::Operation]
|
800
|
+
#
|
801
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
802
|
+
def create_snapshot request, options = nil
|
803
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
804
|
+
|
805
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Filestore::V1::CreateSnapshotRequest
|
806
|
+
|
807
|
+
# Converts hash and nil to an options object
|
808
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
809
|
+
|
810
|
+
# Customize the options with defaults
|
811
|
+
call_metadata = @config.rpcs.create_snapshot.metadata.to_h
|
812
|
+
|
813
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
814
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
815
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
816
|
+
gapic_version: ::Google::Cloud::Filestore::V1::VERSION,
|
817
|
+
transports_version_send: [:rest]
|
818
|
+
|
819
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
820
|
+
|
821
|
+
options.apply_defaults timeout: @config.rpcs.create_snapshot.timeout,
|
822
|
+
metadata: call_metadata,
|
823
|
+
retry_policy: @config.rpcs.create_snapshot.retry_policy
|
824
|
+
|
825
|
+
options.apply_defaults timeout: @config.timeout,
|
826
|
+
metadata: @config.metadata,
|
827
|
+
retry_policy: @config.retry_policy
|
828
|
+
|
829
|
+
@cloud_filestore_manager_stub.create_snapshot request, options do |result, operation|
|
830
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
831
|
+
yield result, operation if block_given?
|
832
|
+
return result
|
833
|
+
end
|
834
|
+
rescue ::Gapic::Rest::Error => e
|
835
|
+
raise ::Google::Cloud::Error.from_error(e)
|
836
|
+
end
|
837
|
+
|
838
|
+
##
|
839
|
+
# Deletes a snapshot.
|
840
|
+
#
|
841
|
+
# @overload delete_snapshot(request, options = nil)
|
842
|
+
# Pass arguments to `delete_snapshot` via a request object, either of type
|
843
|
+
# {::Google::Cloud::Filestore::V1::DeleteSnapshotRequest} or an equivalent Hash.
|
844
|
+
#
|
845
|
+
# @param request [::Google::Cloud::Filestore::V1::DeleteSnapshotRequest, ::Hash]
|
846
|
+
# A request object representing the call parameters. Required. To specify no
|
847
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
848
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
849
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
850
|
+
#
|
851
|
+
# @overload delete_snapshot(name: nil)
|
852
|
+
# Pass arguments to `delete_snapshot` via keyword arguments. Note that at
|
853
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
854
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
855
|
+
#
|
856
|
+
# @param name [::String]
|
857
|
+
# Required. The snapshot resource name, in the format
|
858
|
+
# `projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}`
|
859
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
860
|
+
# @yieldparam result [::Gapic::Operation]
|
861
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
862
|
+
#
|
863
|
+
# @return [::Gapic::Operation]
|
864
|
+
#
|
865
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
866
|
+
def delete_snapshot request, options = nil
|
867
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
868
|
+
|
869
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Filestore::V1::DeleteSnapshotRequest
|
870
|
+
|
871
|
+
# Converts hash and nil to an options object
|
872
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
873
|
+
|
874
|
+
# Customize the options with defaults
|
875
|
+
call_metadata = @config.rpcs.delete_snapshot.metadata.to_h
|
876
|
+
|
877
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
878
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
879
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
880
|
+
gapic_version: ::Google::Cloud::Filestore::V1::VERSION,
|
881
|
+
transports_version_send: [:rest]
|
882
|
+
|
883
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
884
|
+
|
885
|
+
options.apply_defaults timeout: @config.rpcs.delete_snapshot.timeout,
|
886
|
+
metadata: call_metadata,
|
887
|
+
retry_policy: @config.rpcs.delete_snapshot.retry_policy
|
888
|
+
|
889
|
+
options.apply_defaults timeout: @config.timeout,
|
890
|
+
metadata: @config.metadata,
|
891
|
+
retry_policy: @config.retry_policy
|
892
|
+
|
893
|
+
@cloud_filestore_manager_stub.delete_snapshot request, options do |result, operation|
|
894
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
895
|
+
yield result, operation if block_given?
|
896
|
+
return result
|
897
|
+
end
|
898
|
+
rescue ::Gapic::Rest::Error => e
|
899
|
+
raise ::Google::Cloud::Error.from_error(e)
|
900
|
+
end
|
901
|
+
|
902
|
+
##
|
903
|
+
# Updates the settings of a specific snapshot.
|
904
|
+
#
|
905
|
+
# @overload update_snapshot(request, options = nil)
|
906
|
+
# Pass arguments to `update_snapshot` via a request object, either of type
|
907
|
+
# {::Google::Cloud::Filestore::V1::UpdateSnapshotRequest} or an equivalent Hash.
|
908
|
+
#
|
909
|
+
# @param request [::Google::Cloud::Filestore::V1::UpdateSnapshotRequest, ::Hash]
|
910
|
+
# A request object representing the call parameters. Required. To specify no
|
911
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
912
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
913
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
914
|
+
#
|
915
|
+
# @overload update_snapshot(update_mask: nil, snapshot: nil)
|
916
|
+
# Pass arguments to `update_snapshot` via keyword arguments. Note that at
|
917
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
918
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
919
|
+
#
|
920
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
921
|
+
# Required. Mask of fields to update. At least one path must be supplied in
|
922
|
+
# this field.
|
923
|
+
# @param snapshot [::Google::Cloud::Filestore::V1::Snapshot, ::Hash]
|
924
|
+
# Required. A snapshot resource.
|
925
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
926
|
+
# @yieldparam result [::Gapic::Operation]
|
927
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
928
|
+
#
|
929
|
+
# @return [::Gapic::Operation]
|
930
|
+
#
|
931
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
932
|
+
def update_snapshot request, options = nil
|
933
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
934
|
+
|
935
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Filestore::V1::UpdateSnapshotRequest
|
936
|
+
|
937
|
+
# Converts hash and nil to an options object
|
938
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
939
|
+
|
940
|
+
# Customize the options with defaults
|
941
|
+
call_metadata = @config.rpcs.update_snapshot.metadata.to_h
|
942
|
+
|
943
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
944
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
945
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
946
|
+
gapic_version: ::Google::Cloud::Filestore::V1::VERSION,
|
947
|
+
transports_version_send: [:rest]
|
948
|
+
|
949
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
950
|
+
|
951
|
+
options.apply_defaults timeout: @config.rpcs.update_snapshot.timeout,
|
952
|
+
metadata: call_metadata,
|
953
|
+
retry_policy: @config.rpcs.update_snapshot.retry_policy
|
954
|
+
|
955
|
+
options.apply_defaults timeout: @config.timeout,
|
956
|
+
metadata: @config.metadata,
|
957
|
+
retry_policy: @config.retry_policy
|
958
|
+
|
959
|
+
@cloud_filestore_manager_stub.update_snapshot request, options do |result, operation|
|
960
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
961
|
+
yield result, operation if block_given?
|
962
|
+
return result
|
963
|
+
end
|
964
|
+
rescue ::Gapic::Rest::Error => e
|
965
|
+
raise ::Google::Cloud::Error.from_error(e)
|
966
|
+
end
|
967
|
+
|
624
968
|
##
|
625
969
|
# Lists all backups in a project for either a specified location or for all
|
626
970
|
# locations.
|
@@ -643,9 +987,9 @@ module Google
|
|
643
987
|
# @param parent [::String]
|
644
988
|
# Required. The project and location for which to retrieve backup
|
645
989
|
# information, in the format
|
646
|
-
# `projects/{project_number}/locations/{location}`. In
|
647
|
-
#
|
648
|
-
# backup information for all locations, use "-" for the
|
990
|
+
# `projects/{project_number}/locations/{location}`. In Filestore, backup
|
991
|
+
# locations map to Google Cloud regions, for example **us-west1**. To
|
992
|
+
# retrieve backup information for all locations, use "-" for the
|
649
993
|
# `{location}` value.
|
650
994
|
# @param page_size [::Integer]
|
651
995
|
# The maximum number of items to return.
|
@@ -781,8 +1125,8 @@ module Google
|
|
781
1125
|
#
|
782
1126
|
# @param parent [::String]
|
783
1127
|
# Required. The backup's project and location, in the format
|
784
|
-
# `projects/{project_number}/locations/{location}`. In
|
785
|
-
# backup locations map to
|
1128
|
+
# `projects/{project_number}/locations/{location}`. In Filestore,
|
1129
|
+
# backup locations map to Google Cloud regions, for example **us-west1**.
|
786
1130
|
# @param backup [::Google::Cloud::Filestore::V1::Backup, ::Hash]
|
787
1131
|
# Required. A {::Google::Cloud::Filestore::V1::Backup backup resource}
|
788
1132
|
# @param backup_id [::String]
|
@@ -1004,9 +1348,9 @@ module Google
|
|
1004
1348
|
# * (`String`) The path to a service account key file in JSON format
|
1005
1349
|
# * (`Hash`) A service account key as a Hash
|
1006
1350
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1007
|
-
# (see the [googleauth docs](https://
|
1351
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
1008
1352
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1009
|
-
# (see the [signet docs](https://
|
1353
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1010
1354
|
# * (`nil`) indicating no credentials
|
1011
1355
|
# @return [::Object]
|
1012
1356
|
# @!attribute [rw] scope
|
@@ -1120,6 +1464,31 @@ module Google
|
|
1120
1464
|
#
|
1121
1465
|
attr_reader :delete_instance
|
1122
1466
|
##
|
1467
|
+
# RPC-specific configuration for `list_snapshots`
|
1468
|
+
# @return [::Gapic::Config::Method]
|
1469
|
+
#
|
1470
|
+
attr_reader :list_snapshots
|
1471
|
+
##
|
1472
|
+
# RPC-specific configuration for `get_snapshot`
|
1473
|
+
# @return [::Gapic::Config::Method]
|
1474
|
+
#
|
1475
|
+
attr_reader :get_snapshot
|
1476
|
+
##
|
1477
|
+
# RPC-specific configuration for `create_snapshot`
|
1478
|
+
# @return [::Gapic::Config::Method]
|
1479
|
+
#
|
1480
|
+
attr_reader :create_snapshot
|
1481
|
+
##
|
1482
|
+
# RPC-specific configuration for `delete_snapshot`
|
1483
|
+
# @return [::Gapic::Config::Method]
|
1484
|
+
#
|
1485
|
+
attr_reader :delete_snapshot
|
1486
|
+
##
|
1487
|
+
# RPC-specific configuration for `update_snapshot`
|
1488
|
+
# @return [::Gapic::Config::Method]
|
1489
|
+
#
|
1490
|
+
attr_reader :update_snapshot
|
1491
|
+
##
|
1123
1492
|
# RPC-specific configuration for `list_backups`
|
1124
1493
|
# @return [::Gapic::Config::Method]
|
1125
1494
|
#
|
@@ -1159,6 +1528,16 @@ module Google
|
|
1159
1528
|
@restore_instance = ::Gapic::Config::Method.new restore_instance_config
|
1160
1529
|
delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
|
1161
1530
|
@delete_instance = ::Gapic::Config::Method.new delete_instance_config
|
1531
|
+
list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
|
1532
|
+
@list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
|
1533
|
+
get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
|
1534
|
+
@get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
|
1535
|
+
create_snapshot_config = parent_rpcs.create_snapshot if parent_rpcs.respond_to? :create_snapshot
|
1536
|
+
@create_snapshot = ::Gapic::Config::Method.new create_snapshot_config
|
1537
|
+
delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
|
1538
|
+
@delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
|
1539
|
+
update_snapshot_config = parent_rpcs.update_snapshot if parent_rpcs.respond_to? :update_snapshot
|
1540
|
+
@update_snapshot = ::Gapic::Config::Method.new update_snapshot_config
|
1162
1541
|
list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
|
1163
1542
|
@list_backups = ::Gapic::Config::Method.new list_backups_config
|
1164
1543
|
get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
|
@@ -411,9 +411,9 @@ module Google
|
|
411
411
|
# * (`String`) The path to a service account key file in JSON format
|
412
412
|
# * (`Hash`) A service account key as a Hash
|
413
413
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
414
|
-
# (see the [googleauth docs](https://
|
414
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
415
415
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
416
|
-
# (see the [signet docs](https://
|
416
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
417
417
|
# * (`nil`) indicating no credentials
|
418
418
|
# @return [::Object]
|
419
419
|
# @!attribute [rw] scope
|