google-apis-gkehub_v1beta 0.58.0 → 0.59.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -689,6 +689,205 @@ module Google
689
689
  execute_or_queue_command(command, &block)
690
690
  end
691
691
 
692
+ # Creates a new Membership. **This is currently only supported for GKE clusters
693
+ # on Google Cloud**. To register other clusters, follow the instructions at
694
+ # https://cloud.google.com/anthos/multicluster-management/connect/registering-a-
695
+ # cluster.
696
+ # @param [String] parent
697
+ # Required. The parent (project and location) where the Memberships will be
698
+ # created. Specified in the format `projects/*/locations/*`.
699
+ # @param [Google::Apis::GkehubV1beta::Membership] membership_object
700
+ # @param [String] membership_id
701
+ # Required. Client chosen ID for the membership. `membership_id` must be a valid
702
+ # RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must
703
+ # consist of lower case alphanumeric characters or `-` 3. It must start and end
704
+ # with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([
705
+ # -a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
706
+ # @param [String] request_id
707
+ # Optional. A request ID to identify requests. Specify a unique request ID so
708
+ # that if you must retry your request, the server will know to ignore the
709
+ # request if it has already been completed. The server will guarantee that for
710
+ # at least 60 minutes after the first request. For example, consider a situation
711
+ # where you make an initial request and the request times out. If you make the
712
+ # request again with the same request ID, the server can check if original
713
+ # operation with the same request ID was received, and if so, will ignore the
714
+ # second request. This prevents clients from accidentally creating duplicate
715
+ # commitments. The request ID must be a valid UUID with the exception that zero
716
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
717
+ # @param [String] fields
718
+ # Selector specifying which fields to include in a partial response.
719
+ # @param [String] quota_user
720
+ # Available to use for quota purposes for server-side applications. Can be any
721
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
722
+ # @param [Google::Apis::RequestOptions] options
723
+ # Request-specific options
724
+ #
725
+ # @yield [result, err] Result & error if block supplied
726
+ # @yieldparam result [Google::Apis::GkehubV1beta::Operation] parsed result object
727
+ # @yieldparam err [StandardError] error object if request failed
728
+ #
729
+ # @return [Google::Apis::GkehubV1beta::Operation]
730
+ #
731
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
732
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
733
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
734
+ def create_project_location_membership(parent, membership_object = nil, membership_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
735
+ command = make_simple_command(:post, 'v1beta/{+parent}/memberships', options)
736
+ command.request_representation = Google::Apis::GkehubV1beta::Membership::Representation
737
+ command.request_object = membership_object
738
+ command.response_representation = Google::Apis::GkehubV1beta::Operation::Representation
739
+ command.response_class = Google::Apis::GkehubV1beta::Operation
740
+ command.params['parent'] = parent unless parent.nil?
741
+ command.query['membershipId'] = membership_id unless membership_id.nil?
742
+ command.query['requestId'] = request_id unless request_id.nil?
743
+ command.query['fields'] = fields unless fields.nil?
744
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
745
+ execute_or_queue_command(command, &block)
746
+ end
747
+
748
+ # Removes a Membership. **This is currently only supported for GKE clusters on
749
+ # Google Cloud**. To unregister other clusters, follow the instructions at https:
750
+ # //cloud.google.com/anthos/multicluster-management/connect/unregistering-a-
751
+ # cluster.
752
+ # @param [String] name
753
+ # Required. The Membership resource name in the format `projects/*/locations/*/
754
+ # memberships/*`.
755
+ # @param [Boolean] force
756
+ # Optional. If set to true, any subresource from this Membership will also be
757
+ # deleted. Otherwise, the request will only work if the Membership has no
758
+ # subresource.
759
+ # @param [String] request_id
760
+ # Optional. A request ID to identify requests. Specify a unique request ID so
761
+ # that if you must retry your request, the server will know to ignore the
762
+ # request if it has already been completed. The server will guarantee that for
763
+ # at least 60 minutes after the first request. For example, consider a situation
764
+ # where you make an initial request and the request times out. If you make the
765
+ # request again with the same request ID, the server can check if original
766
+ # operation with the same request ID was received, and if so, will ignore the
767
+ # second request. This prevents clients from accidentally creating duplicate
768
+ # commitments. The request ID must be a valid UUID with the exception that zero
769
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
770
+ # @param [String] fields
771
+ # Selector specifying which fields to include in a partial response.
772
+ # @param [String] quota_user
773
+ # Available to use for quota purposes for server-side applications. Can be any
774
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
775
+ # @param [Google::Apis::RequestOptions] options
776
+ # Request-specific options
777
+ #
778
+ # @yield [result, err] Result & error if block supplied
779
+ # @yieldparam result [Google::Apis::GkehubV1beta::Operation] parsed result object
780
+ # @yieldparam err [StandardError] error object if request failed
781
+ #
782
+ # @return [Google::Apis::GkehubV1beta::Operation]
783
+ #
784
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
785
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
786
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
787
+ def delete_project_location_membership(name, force: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
788
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
789
+ command.response_representation = Google::Apis::GkehubV1beta::Operation::Representation
790
+ command.response_class = Google::Apis::GkehubV1beta::Operation
791
+ command.params['name'] = name unless name.nil?
792
+ command.query['force'] = force unless force.nil?
793
+ command.query['requestId'] = request_id unless request_id.nil?
794
+ command.query['fields'] = fields unless fields.nil?
795
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
796
+ execute_or_queue_command(command, &block)
797
+ end
798
+
799
+ # Generates the manifest for deployment of the GKE connect agent. **This method
800
+ # is used internally by Google-provided libraries.** Most clients should not
801
+ # need to call this method directly.
802
+ # @param [String] name
803
+ # Required. The Membership resource name the Agent will associate with, in the
804
+ # format `projects/*/locations/*/memberships/*`.
805
+ # @param [String] image_pull_secret_content
806
+ # Optional. The image pull secret content for the registry, if not public.
807
+ # @param [Boolean] is_upgrade
808
+ # Optional. If true, generate the resources for upgrade only. Some resources
809
+ # generated only for installation (e.g. secrets) will be excluded.
810
+ # @param [String] namespace
811
+ # Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.
812
+ # The Connect Agent is authorized automatically when run in the default
813
+ # namespace. Otherwise, explicit authorization must be granted with an
814
+ # additional IAM binding.
815
+ # @param [String] proxy
816
+ # Optional. URI of a proxy if connectivity from the agent to gkeconnect.
817
+ # googleapis.com requires the use of a proxy. Format must be in the form `http(s)
818
+ # ://`proxy_address``, depending on the HTTP/HTTPS protocol supported by the
819
+ # proxy. This will direct the connect agent's outbound traffic through a HTTP(S)
820
+ # proxy.
821
+ # @param [String] registry
822
+ # Optional. The registry to fetch the connect agent image from. Defaults to gcr.
823
+ # io/gkeconnect.
824
+ # @param [String] version
825
+ # Optional. The Connect agent version to use. Defaults to the most current
826
+ # version.
827
+ # @param [String] fields
828
+ # Selector specifying which fields to include in a partial response.
829
+ # @param [String] quota_user
830
+ # Available to use for quota purposes for server-side applications. Can be any
831
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
832
+ # @param [Google::Apis::RequestOptions] options
833
+ # Request-specific options
834
+ #
835
+ # @yield [result, err] Result & error if block supplied
836
+ # @yieldparam result [Google::Apis::GkehubV1beta::GenerateConnectManifestResponse] parsed result object
837
+ # @yieldparam err [StandardError] error object if request failed
838
+ #
839
+ # @return [Google::Apis::GkehubV1beta::GenerateConnectManifestResponse]
840
+ #
841
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
842
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
843
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
844
+ def generate_project_location_membership_connect_manifest(name, image_pull_secret_content: nil, is_upgrade: nil, namespace: nil, proxy: nil, registry: nil, version: nil, fields: nil, quota_user: nil, options: nil, &block)
845
+ command = make_simple_command(:get, 'v1beta/{+name}:generateConnectManifest', options)
846
+ command.response_representation = Google::Apis::GkehubV1beta::GenerateConnectManifestResponse::Representation
847
+ command.response_class = Google::Apis::GkehubV1beta::GenerateConnectManifestResponse
848
+ command.params['name'] = name unless name.nil?
849
+ command.query['imagePullSecretContent'] = image_pull_secret_content unless image_pull_secret_content.nil?
850
+ command.query['isUpgrade'] = is_upgrade unless is_upgrade.nil?
851
+ command.query['namespace'] = namespace unless namespace.nil?
852
+ command.query['proxy'] = proxy unless proxy.nil?
853
+ command.query['registry'] = registry unless registry.nil?
854
+ command.query['version'] = version unless version.nil?
855
+ command.query['fields'] = fields unless fields.nil?
856
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
857
+ execute_or_queue_command(command, &block)
858
+ end
859
+
860
+ # Gets the details of a Membership.
861
+ # @param [String] name
862
+ # Required. The Membership resource name in the format `projects/*/locations/*/
863
+ # memberships/*`.
864
+ # @param [String] fields
865
+ # Selector specifying which fields to include in a partial response.
866
+ # @param [String] quota_user
867
+ # Available to use for quota purposes for server-side applications. Can be any
868
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
869
+ # @param [Google::Apis::RequestOptions] options
870
+ # Request-specific options
871
+ #
872
+ # @yield [result, err] Result & error if block supplied
873
+ # @yieldparam result [Google::Apis::GkehubV1beta::Membership] parsed result object
874
+ # @yieldparam err [StandardError] error object if request failed
875
+ #
876
+ # @return [Google::Apis::GkehubV1beta::Membership]
877
+ #
878
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
879
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
880
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
881
+ def get_project_location_membership(name, fields: nil, quota_user: nil, options: nil, &block)
882
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
883
+ command.response_representation = Google::Apis::GkehubV1beta::Membership::Representation
884
+ command.response_class = Google::Apis::GkehubV1beta::Membership
885
+ command.params['name'] = name unless name.nil?
886
+ command.query['fields'] = fields unless fields.nil?
887
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
888
+ execute_or_queue_command(command, &block)
889
+ end
890
+
692
891
  # Gets the access control policy for a resource. Returns an empty policy if the
693
892
  # resource exists and does not have a policy set.
694
893
  # @param [String] resource
@@ -734,6 +933,108 @@ module Google
734
933
  execute_or_queue_command(command, &block)
735
934
  end
736
935
 
936
+ # Lists Memberships in a given project and location.
937
+ # @param [String] parent
938
+ # Required. The parent (project and location) where the Memberships will be
939
+ # listed. Specified in the format `projects/*/locations/*`. `projects/*/
940
+ # locations/-` list memberships in all the regions.
941
+ # @param [String] filter
942
+ # Optional. Lists Memberships that match the filter expression, following the
943
+ # syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in
944
+ # project `foo-proj` and location `global`: name = "projects/foo-proj/locations/
945
+ # global/membership/bar" - Memberships that have a label called `foo`: labels.
946
+ # foo:* - Memberships that have a label called `foo` whose value is `bar`:
947
+ # labels.foo = bar - Memberships in the CREATING state: state = CREATING
948
+ # @param [String] order_by
949
+ # Optional. One or more fields to compare and use to sort the output. See https:/
950
+ # /google.aip.dev/132#ordering.
951
+ # @param [Fixnum] page_size
952
+ # Optional. When requesting a 'page' of resources, `page_size` specifies number
953
+ # of resources to return. If unspecified or set to 0, all resources will be
954
+ # returned.
955
+ # @param [String] page_token
956
+ # Optional. Token returned by previous call to `ListMemberships` which specifies
957
+ # the position in the list from where to continue listing the resources.
958
+ # @param [String] fields
959
+ # Selector specifying which fields to include in a partial response.
960
+ # @param [String] quota_user
961
+ # Available to use for quota purposes for server-side applications. Can be any
962
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
963
+ # @param [Google::Apis::RequestOptions] options
964
+ # Request-specific options
965
+ #
966
+ # @yield [result, err] Result & error if block supplied
967
+ # @yieldparam result [Google::Apis::GkehubV1beta::ListMembershipsResponse] parsed result object
968
+ # @yieldparam err [StandardError] error object if request failed
969
+ #
970
+ # @return [Google::Apis::GkehubV1beta::ListMembershipsResponse]
971
+ #
972
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
973
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
974
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
975
+ def list_project_location_memberships(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
976
+ command = make_simple_command(:get, 'v1beta/{+parent}/memberships', options)
977
+ command.response_representation = Google::Apis::GkehubV1beta::ListMembershipsResponse::Representation
978
+ command.response_class = Google::Apis::GkehubV1beta::ListMembershipsResponse
979
+ command.params['parent'] = parent unless parent.nil?
980
+ command.query['filter'] = filter unless filter.nil?
981
+ command.query['orderBy'] = order_by unless order_by.nil?
982
+ command.query['pageSize'] = page_size unless page_size.nil?
983
+ command.query['pageToken'] = page_token unless page_token.nil?
984
+ command.query['fields'] = fields unless fields.nil?
985
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
986
+ execute_or_queue_command(command, &block)
987
+ end
988
+
989
+ # Updates an existing Membership.
990
+ # @param [String] name
991
+ # Required. The Membership resource name in the format `projects/*/locations/*/
992
+ # memberships/*`.
993
+ # @param [Google::Apis::GkehubV1beta::Membership] membership_object
994
+ # @param [String] request_id
995
+ # Optional. A request ID to identify requests. Specify a unique request ID so
996
+ # that if you must retry your request, the server will know to ignore the
997
+ # request if it has already been completed. The server will guarantee that for
998
+ # at least 60 minutes after the first request. For example, consider a situation
999
+ # where you make an initial request and the request times out. If you make the
1000
+ # request again with the same request ID, the server can check if original
1001
+ # operation with the same request ID was received, and if so, will ignore the
1002
+ # second request. This prevents clients from accidentally creating duplicate
1003
+ # commitments. The request ID must be a valid UUID with the exception that zero
1004
+ # UUID is not supported (00000000-0000-0000-0000-000000000000).
1005
+ # @param [String] update_mask
1006
+ # Required. Mask of fields to update.
1007
+ # @param [String] fields
1008
+ # Selector specifying which fields to include in a partial response.
1009
+ # @param [String] quota_user
1010
+ # Available to use for quota purposes for server-side applications. Can be any
1011
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1012
+ # @param [Google::Apis::RequestOptions] options
1013
+ # Request-specific options
1014
+ #
1015
+ # @yield [result, err] Result & error if block supplied
1016
+ # @yieldparam result [Google::Apis::GkehubV1beta::Operation] parsed result object
1017
+ # @yieldparam err [StandardError] error object if request failed
1018
+ #
1019
+ # @return [Google::Apis::GkehubV1beta::Operation]
1020
+ #
1021
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1022
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1023
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1024
+ def patch_project_location_membership(name, membership_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1025
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1026
+ command.request_representation = Google::Apis::GkehubV1beta::Membership::Representation
1027
+ command.request_object = membership_object
1028
+ command.response_representation = Google::Apis::GkehubV1beta::Operation::Representation
1029
+ command.response_class = Google::Apis::GkehubV1beta::Operation
1030
+ command.params['name'] = name unless name.nil?
1031
+ command.query['requestId'] = request_id unless request_id.nil?
1032
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1033
+ command.query['fields'] = fields unless fields.nil?
1034
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1035
+ execute_or_queue_command(command, &block)
1036
+ end
1037
+
737
1038
  # Sets the access control policy on the specified resource. Replaces any
738
1039
  # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
739
1040
  # PERMISSION_DENIED` errors.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-gkehub_v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.58.0
4
+ version: 0.59.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-01 00:00:00.000000000 Z
11
+ date: 2023-10-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gkehub_v1beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-gkehub_v1beta/v0.58.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-gkehub_v1beta/v0.59.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-gkehub_v1beta
63
63
  post_install_message:
64
64
  rdoc_options: []