google-apis-managedkafka_v1 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -84,6 +84,9 @@ module Google
84
84
  # Lists information about the supported locations for this service.
85
85
  # @param [String] name
86
86
  # The resource that owns the locations collection, if applicable.
87
+ # @param [Array<String>, String] extra_location_types
88
+ # Optional. A list of extra location types that should be used as conditions for
89
+ # controlling the visibility of the locations.
87
90
  # @param [String] filter
88
91
  # A filter to narrow down results to a preferred subset. The filtering language
89
92
  # accepts strings like `"displayName=tokyo"`, and is documented in more detail
@@ -111,11 +114,12 @@ module Google
111
114
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
112
115
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
113
116
  # @raise [Google::Apis::AuthorizationError] Authorization is required
114
- def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
117
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
115
118
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
116
119
  command.response_representation = Google::Apis::ManagedkafkaV1::ListLocationsResponse::Representation
117
120
  command.response_class = Google::Apis::ManagedkafkaV1::ListLocationsResponse
118
121
  command.params['name'] = name unless name.nil?
122
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
119
123
  command.query['filter'] = filter unless filter.nil?
120
124
  command.query['pageSize'] = page_size unless page_size.nil?
121
125
  command.query['pageToken'] = page_token unless page_token.nil?
@@ -677,6 +681,562 @@ module Google
677
681
  execute_or_queue_command(command, &block)
678
682
  end
679
683
 
684
+ # Creates a new Kafka Connect cluster in a given project and location.
685
+ # @param [String] parent
686
+ # Required. The parent project/location in which to create the Kafka Connect
687
+ # cluster. Structured like `projects/`project`/locations/`location`/`.
688
+ # @param [Google::Apis::ManagedkafkaV1::ConnectCluster] connect_cluster_object
689
+ # @param [String] connect_cluster_id
690
+ # Required. The ID to use for the Connect cluster, which will become the final
691
+ # component of the cluster's name. The ID must be 1-63 characters long, and
692
+ # match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC
693
+ # 1035. This value is structured like: `my-cluster-id`.
694
+ # @param [String] request_id
695
+ # Optional. An optional request ID to identify requests. Specify a unique
696
+ # request ID to avoid duplication of requests. If a request times out or fails,
697
+ # retrying with the same ID allows the server to recognize the previous attempt.
698
+ # For at least 60 minutes, the server ignores duplicate requests bearing the
699
+ # same ID. For example, consider a situation where you make an initial request
700
+ # and the request times out. If you make the request again with the same request
701
+ # ID within 60 minutes of the last request, the server checks if an original
702
+ # operation with the same request ID was received. If so, the server ignores the
703
+ # second request. The request ID must be a valid UUID. A zero UUID is not
704
+ # supported (00000000-0000-0000-0000-000000000000).
705
+ # @param [String] fields
706
+ # Selector specifying which fields to include in a partial response.
707
+ # @param [String] quota_user
708
+ # Available to use for quota purposes for server-side applications. Can be any
709
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
710
+ # @param [Google::Apis::RequestOptions] options
711
+ # Request-specific options
712
+ #
713
+ # @yield [result, err] Result & error if block supplied
714
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Operation] parsed result object
715
+ # @yieldparam err [StandardError] error object if request failed
716
+ #
717
+ # @return [Google::Apis::ManagedkafkaV1::Operation]
718
+ #
719
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
720
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
721
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
722
+ def create_project_location_connect_cluster(parent, connect_cluster_object = nil, connect_cluster_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
723
+ command = make_simple_command(:post, 'v1/{+parent}/connectClusters', options)
724
+ command.request_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
725
+ command.request_object = connect_cluster_object
726
+ command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
727
+ command.response_class = Google::Apis::ManagedkafkaV1::Operation
728
+ command.params['parent'] = parent unless parent.nil?
729
+ command.query['connectClusterId'] = connect_cluster_id unless connect_cluster_id.nil?
730
+ command.query['requestId'] = request_id unless request_id.nil?
731
+ command.query['fields'] = fields unless fields.nil?
732
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
733
+ execute_or_queue_command(command, &block)
734
+ end
735
+
736
+ # Deletes a single Connect cluster.
737
+ # @param [String] name
738
+ # Required. The name of the Kafka Connect cluster to delete. Structured like `
739
+ # projects/`project`/locations/`location`/connectClusters/`connect_cluster_id``.
740
+ # @param [String] request_id
741
+ # Optional. An optional request ID to identify requests. Specify a unique
742
+ # request ID to avoid duplication of requests. If a request times out or fails,
743
+ # retrying with the same ID allows the server to recognize the previous attempt.
744
+ # For at least 60 minutes, the server ignores duplicate requests bearing the
745
+ # same ID. For example, consider a situation where you make an initial request
746
+ # and the request times out. If you make the request again with the same request
747
+ # ID within 60 minutes of the last request, the server checks if an original
748
+ # operation with the same request ID was received. If so, the server ignores the
749
+ # second request. The request ID must be a valid UUID. A zero UUID is not
750
+ # supported (00000000-0000-0000-0000-000000000000).
751
+ # @param [String] fields
752
+ # Selector specifying which fields to include in a partial response.
753
+ # @param [String] quota_user
754
+ # Available to use for quota purposes for server-side applications. Can be any
755
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
756
+ # @param [Google::Apis::RequestOptions] options
757
+ # Request-specific options
758
+ #
759
+ # @yield [result, err] Result & error if block supplied
760
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Operation] parsed result object
761
+ # @yieldparam err [StandardError] error object if request failed
762
+ #
763
+ # @return [Google::Apis::ManagedkafkaV1::Operation]
764
+ #
765
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
766
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
767
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
768
+ def delete_project_location_connect_cluster(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
769
+ command = make_simple_command(:delete, 'v1/{+name}', options)
770
+ command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
771
+ command.response_class = Google::Apis::ManagedkafkaV1::Operation
772
+ command.params['name'] = name unless name.nil?
773
+ command.query['requestId'] = request_id unless request_id.nil?
774
+ command.query['fields'] = fields unless fields.nil?
775
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
776
+ execute_or_queue_command(command, &block)
777
+ end
778
+
779
+ # Returns the properties of a single Kafka Connect cluster.
780
+ # @param [String] name
781
+ # Required. The name of the Kafka Connect cluster whose configuration to return.
782
+ # Structured like `projects/`project`/locations/`location`/connectClusters/`
783
+ # connect_cluster_id``.
784
+ # @param [String] fields
785
+ # Selector specifying which fields to include in a partial response.
786
+ # @param [String] quota_user
787
+ # Available to use for quota purposes for server-side applications. Can be any
788
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
789
+ # @param [Google::Apis::RequestOptions] options
790
+ # Request-specific options
791
+ #
792
+ # @yield [result, err] Result & error if block supplied
793
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::ConnectCluster] parsed result object
794
+ # @yieldparam err [StandardError] error object if request failed
795
+ #
796
+ # @return [Google::Apis::ManagedkafkaV1::ConnectCluster]
797
+ #
798
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
799
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
800
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
801
+ def get_project_location_connect_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
802
+ command = make_simple_command(:get, 'v1/{+name}', options)
803
+ command.response_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
804
+ command.response_class = Google::Apis::ManagedkafkaV1::ConnectCluster
805
+ command.params['name'] = name unless name.nil?
806
+ command.query['fields'] = fields unless fields.nil?
807
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
808
+ execute_or_queue_command(command, &block)
809
+ end
810
+
811
+ # Lists the Kafka Connect clusters in a given project and location.
812
+ # @param [String] parent
813
+ # Required. The parent project/location whose Connect clusters are to be listed.
814
+ # Structured like `projects/`project`/locations/`location``.
815
+ # @param [String] filter
816
+ # Optional. Filter expression for the result.
817
+ # @param [String] order_by
818
+ # Optional. Order by fields for the result.
819
+ # @param [Fixnum] page_size
820
+ # Optional. The maximum number of Connect clusters to return. The service may
821
+ # return fewer than this value. If unspecified, server will pick an appropriate
822
+ # default.
823
+ # @param [String] page_token
824
+ # Optional. A page token, received from a previous `ListConnectClusters` call.
825
+ # Provide this to retrieve the subsequent page. When paginating, all other
826
+ # parameters provided to `ListConnectClusters` must match the call that provided
827
+ # the page token.
828
+ # @param [String] fields
829
+ # Selector specifying which fields to include in a partial response.
830
+ # @param [String] quota_user
831
+ # Available to use for quota purposes for server-side applications. Can be any
832
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
833
+ # @param [Google::Apis::RequestOptions] options
834
+ # Request-specific options
835
+ #
836
+ # @yield [result, err] Result & error if block supplied
837
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::ListConnectClustersResponse] parsed result object
838
+ # @yieldparam err [StandardError] error object if request failed
839
+ #
840
+ # @return [Google::Apis::ManagedkafkaV1::ListConnectClustersResponse]
841
+ #
842
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
843
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
844
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
845
+ def list_project_location_connect_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
846
+ command = make_simple_command(:get, 'v1/{+parent}/connectClusters', options)
847
+ command.response_representation = Google::Apis::ManagedkafkaV1::ListConnectClustersResponse::Representation
848
+ command.response_class = Google::Apis::ManagedkafkaV1::ListConnectClustersResponse
849
+ command.params['parent'] = parent unless parent.nil?
850
+ command.query['filter'] = filter unless filter.nil?
851
+ command.query['orderBy'] = order_by unless order_by.nil?
852
+ command.query['pageSize'] = page_size unless page_size.nil?
853
+ command.query['pageToken'] = page_token unless page_token.nil?
854
+ command.query['fields'] = fields unless fields.nil?
855
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
856
+ execute_or_queue_command(command, &block)
857
+ end
858
+
859
+ # Updates the properties of a single Kafka Connect cluster.
860
+ # @param [String] name
861
+ # Identifier. The name of the Kafka Connect cluster. Structured like: projects/`
862
+ # project_number`/locations/`location`/connectClusters/`connect_cluster_id`
863
+ # @param [Google::Apis::ManagedkafkaV1::ConnectCluster] connect_cluster_object
864
+ # @param [String] request_id
865
+ # Optional. An optional request ID to identify requests. Specify a unique
866
+ # request ID to avoid duplication of requests. If a request times out or fails,
867
+ # retrying with the same ID allows the server to recognize the previous attempt.
868
+ # For at least 60 minutes, the server ignores duplicate requests bearing the
869
+ # same ID. For example, consider a situation where you make an initial request
870
+ # and the request times out. If you make the request again with the same request
871
+ # ID within 60 minutes of the last request, the server checks if an original
872
+ # operation with the same request ID was received. If so, the server ignores the
873
+ # second request. The request ID must be a valid UUID. A zero UUID is not
874
+ # supported (00000000-0000-0000-0000-000000000000).
875
+ # @param [String] update_mask
876
+ # Required. Field mask is used to specify the fields to be overwritten in the
877
+ # cluster resource by the update. The fields specified in the update_mask are
878
+ # relative to the resource, not the full request. A field will be overwritten if
879
+ # it is in the mask. The mask is required and a value of * will update all
880
+ # fields.
881
+ # @param [String] fields
882
+ # Selector specifying which fields to include in a partial response.
883
+ # @param [String] quota_user
884
+ # Available to use for quota purposes for server-side applications. Can be any
885
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
886
+ # @param [Google::Apis::RequestOptions] options
887
+ # Request-specific options
888
+ #
889
+ # @yield [result, err] Result & error if block supplied
890
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Operation] parsed result object
891
+ # @yieldparam err [StandardError] error object if request failed
892
+ #
893
+ # @return [Google::Apis::ManagedkafkaV1::Operation]
894
+ #
895
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
896
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
897
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
898
+ def patch_project_location_connect_cluster(name, connect_cluster_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
899
+ command = make_simple_command(:patch, 'v1/{+name}', options)
900
+ command.request_representation = Google::Apis::ManagedkafkaV1::ConnectCluster::Representation
901
+ command.request_object = connect_cluster_object
902
+ command.response_representation = Google::Apis::ManagedkafkaV1::Operation::Representation
903
+ command.response_class = Google::Apis::ManagedkafkaV1::Operation
904
+ command.params['name'] = name unless name.nil?
905
+ command.query['requestId'] = request_id unless request_id.nil?
906
+ command.query['updateMask'] = update_mask unless update_mask.nil?
907
+ command.query['fields'] = fields unless fields.nil?
908
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
909
+ execute_or_queue_command(command, &block)
910
+ end
911
+
912
+ # Creates a new connector in a given Connect cluster.
913
+ # @param [String] parent
914
+ # Required. The parent Connect cluster in which to create the connector.
915
+ # Structured like `projects/`project`/locations/`location`/connectClusters/`
916
+ # connect_cluster_id``.
917
+ # @param [Google::Apis::ManagedkafkaV1::Connector] connector_object
918
+ # @param [String] connector_id
919
+ # Required. The ID to use for the connector, which will become the final
920
+ # component of the connector's name. The ID must be 1-63 characters long, and
921
+ # match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC
922
+ # 1035. This value is structured like: `my-connector-id`.
923
+ # @param [String] fields
924
+ # Selector specifying which fields to include in a partial response.
925
+ # @param [String] quota_user
926
+ # Available to use for quota purposes for server-side applications. Can be any
927
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
928
+ # @param [Google::Apis::RequestOptions] options
929
+ # Request-specific options
930
+ #
931
+ # @yield [result, err] Result & error if block supplied
932
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Connector] parsed result object
933
+ # @yieldparam err [StandardError] error object if request failed
934
+ #
935
+ # @return [Google::Apis::ManagedkafkaV1::Connector]
936
+ #
937
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
938
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
939
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
940
+ def create_project_location_connect_cluster_connector(parent, connector_object = nil, connector_id: nil, fields: nil, quota_user: nil, options: nil, &block)
941
+ command = make_simple_command(:post, 'v1/{+parent}/connectors', options)
942
+ command.request_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
943
+ command.request_object = connector_object
944
+ command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
945
+ command.response_class = Google::Apis::ManagedkafkaV1::Connector
946
+ command.params['parent'] = parent unless parent.nil?
947
+ command.query['connectorId'] = connector_id unless connector_id.nil?
948
+ command.query['fields'] = fields unless fields.nil?
949
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
950
+ execute_or_queue_command(command, &block)
951
+ end
952
+
953
+ # Deletes a connector.
954
+ # @param [String] name
955
+ # Required. The name of the connector to delete. Structured like: projects/`
956
+ # project`/locations/`location`/connectClusters/`connectCluster`/connectors/`
957
+ # connector`
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::ManagedkafkaV1::Empty] parsed result object
968
+ # @yieldparam err [StandardError] error object if request failed
969
+ #
970
+ # @return [Google::Apis::ManagedkafkaV1::Empty]
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 delete_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil, &block)
976
+ command = make_simple_command(:delete, 'v1/{+name}', options)
977
+ command.response_representation = Google::Apis::ManagedkafkaV1::Empty::Representation
978
+ command.response_class = Google::Apis::ManagedkafkaV1::Empty
979
+ command.params['name'] = name unless name.nil?
980
+ command.query['fields'] = fields unless fields.nil?
981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
982
+ execute_or_queue_command(command, &block)
983
+ end
984
+
985
+ # Returns the properties of a single connector.
986
+ # @param [String] name
987
+ # Required. The name of the connector whose configuration to return. Structured
988
+ # like: projects/`project`/locations/`location`/connectClusters/`connectCluster`/
989
+ # connectors/`connector`
990
+ # @param [String] fields
991
+ # Selector specifying which fields to include in a partial response.
992
+ # @param [String] quota_user
993
+ # Available to use for quota purposes for server-side applications. Can be any
994
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
995
+ # @param [Google::Apis::RequestOptions] options
996
+ # Request-specific options
997
+ #
998
+ # @yield [result, err] Result & error if block supplied
999
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Connector] parsed result object
1000
+ # @yieldparam err [StandardError] error object if request failed
1001
+ #
1002
+ # @return [Google::Apis::ManagedkafkaV1::Connector]
1003
+ #
1004
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1005
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1006
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1007
+ def get_project_location_connect_cluster_connector(name, fields: nil, quota_user: nil, options: nil, &block)
1008
+ command = make_simple_command(:get, 'v1/{+name}', options)
1009
+ command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
1010
+ command.response_class = Google::Apis::ManagedkafkaV1::Connector
1011
+ command.params['name'] = name unless name.nil?
1012
+ command.query['fields'] = fields unless fields.nil?
1013
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1014
+ execute_or_queue_command(command, &block)
1015
+ end
1016
+
1017
+ # Lists the connectors in a given Connect cluster.
1018
+ # @param [String] parent
1019
+ # Required. The parent Connect cluster whose connectors are to be listed.
1020
+ # Structured like `projects/`project`/locations/`location`/connectClusters/`
1021
+ # connect_cluster_id``.
1022
+ # @param [Fixnum] page_size
1023
+ # Optional. The maximum number of connectors to return. The service may return
1024
+ # fewer than this value. If unspecified, server will pick an appropriate default.
1025
+ # @param [String] page_token
1026
+ # Optional. A page token, received from a previous `ListConnectors` call.
1027
+ # Provide this to retrieve the subsequent page. When paginating, all other
1028
+ # parameters provided to `ListConnectors` must match the call that provided the
1029
+ # page token.
1030
+ # @param [String] fields
1031
+ # Selector specifying which fields to include in a partial response.
1032
+ # @param [String] quota_user
1033
+ # Available to use for quota purposes for server-side applications. Can be any
1034
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1035
+ # @param [Google::Apis::RequestOptions] options
1036
+ # Request-specific options
1037
+ #
1038
+ # @yield [result, err] Result & error if block supplied
1039
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::ListConnectorsResponse] parsed result object
1040
+ # @yieldparam err [StandardError] error object if request failed
1041
+ #
1042
+ # @return [Google::Apis::ManagedkafkaV1::ListConnectorsResponse]
1043
+ #
1044
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1045
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1046
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1047
+ def list_project_location_connect_cluster_connectors(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1048
+ command = make_simple_command(:get, 'v1/{+parent}/connectors', options)
1049
+ command.response_representation = Google::Apis::ManagedkafkaV1::ListConnectorsResponse::Representation
1050
+ command.response_class = Google::Apis::ManagedkafkaV1::ListConnectorsResponse
1051
+ command.params['parent'] = parent unless parent.nil?
1052
+ command.query['pageSize'] = page_size unless page_size.nil?
1053
+ command.query['pageToken'] = page_token unless page_token.nil?
1054
+ command.query['fields'] = fields unless fields.nil?
1055
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1056
+ execute_or_queue_command(command, &block)
1057
+ end
1058
+
1059
+ # Updates the properties of a connector.
1060
+ # @param [String] name
1061
+ # Identifier. The name of the connector. Structured like: projects/`project`/
1062
+ # locations/`location`/connectClusters/`connect_cluster`/connectors/`connector`
1063
+ # @param [Google::Apis::ManagedkafkaV1::Connector] connector_object
1064
+ # @param [String] update_mask
1065
+ # Required. Field mask is used to specify the fields to be overwritten in the
1066
+ # cluster resource by the update. The fields specified in the update_mask are
1067
+ # relative to the resource, not the full request. A field will be overwritten if
1068
+ # it is in the mask. The mask is required and a value of * will update all
1069
+ # fields.
1070
+ # @param [String] fields
1071
+ # Selector specifying which fields to include in a partial response.
1072
+ # @param [String] quota_user
1073
+ # Available to use for quota purposes for server-side applications. Can be any
1074
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1075
+ # @param [Google::Apis::RequestOptions] options
1076
+ # Request-specific options
1077
+ #
1078
+ # @yield [result, err] Result & error if block supplied
1079
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::Connector] parsed result object
1080
+ # @yieldparam err [StandardError] error object if request failed
1081
+ #
1082
+ # @return [Google::Apis::ManagedkafkaV1::Connector]
1083
+ #
1084
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1085
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1086
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1087
+ def patch_project_location_connect_cluster_connector(name, connector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1088
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1089
+ command.request_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
1090
+ command.request_object = connector_object
1091
+ command.response_representation = Google::Apis::ManagedkafkaV1::Connector::Representation
1092
+ command.response_class = Google::Apis::ManagedkafkaV1::Connector
1093
+ command.params['name'] = name unless name.nil?
1094
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1095
+ command.query['fields'] = fields unless fields.nil?
1096
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1097
+ execute_or_queue_command(command, &block)
1098
+ end
1099
+
1100
+ # Pauses the connector and its tasks.
1101
+ # @param [String] name
1102
+ # Required. The name of the connector to pause. Structured like: projects/`
1103
+ # project`/locations/`location`/connectClusters/`connectCluster`/connectors/`
1104
+ # connector`
1105
+ # @param [Google::Apis::ManagedkafkaV1::PauseConnectorRequest] pause_connector_request_object
1106
+ # @param [String] fields
1107
+ # Selector specifying which fields to include in a partial response.
1108
+ # @param [String] quota_user
1109
+ # Available to use for quota purposes for server-side applications. Can be any
1110
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1111
+ # @param [Google::Apis::RequestOptions] options
1112
+ # Request-specific options
1113
+ #
1114
+ # @yield [result, err] Result & error if block supplied
1115
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::PauseConnectorResponse] parsed result object
1116
+ # @yieldparam err [StandardError] error object if request failed
1117
+ #
1118
+ # @return [Google::Apis::ManagedkafkaV1::PauseConnectorResponse]
1119
+ #
1120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1123
+ def pause_connector(name, pause_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1124
+ command = make_simple_command(:post, 'v1/{+name}:pause', options)
1125
+ command.request_representation = Google::Apis::ManagedkafkaV1::PauseConnectorRequest::Representation
1126
+ command.request_object = pause_connector_request_object
1127
+ command.response_representation = Google::Apis::ManagedkafkaV1::PauseConnectorResponse::Representation
1128
+ command.response_class = Google::Apis::ManagedkafkaV1::PauseConnectorResponse
1129
+ command.params['name'] = name unless name.nil?
1130
+ command.query['fields'] = fields unless fields.nil?
1131
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1132
+ execute_or_queue_command(command, &block)
1133
+ end
1134
+
1135
+ # Restarts the connector.
1136
+ # @param [String] name
1137
+ # Required. The name of the connector to restart. Structured like: projects/`
1138
+ # project`/locations/`location`/connectClusters/`connectCluster`/connectors/`
1139
+ # connector`
1140
+ # @param [Google::Apis::ManagedkafkaV1::RestartConnectorRequest] restart_connector_request_object
1141
+ # @param [String] fields
1142
+ # Selector specifying which fields to include in a partial response.
1143
+ # @param [String] quota_user
1144
+ # Available to use for quota purposes for server-side applications. Can be any
1145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1146
+ # @param [Google::Apis::RequestOptions] options
1147
+ # Request-specific options
1148
+ #
1149
+ # @yield [result, err] Result & error if block supplied
1150
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::RestartConnectorResponse] parsed result object
1151
+ # @yieldparam err [StandardError] error object if request failed
1152
+ #
1153
+ # @return [Google::Apis::ManagedkafkaV1::RestartConnectorResponse]
1154
+ #
1155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1158
+ def restart_connector(name, restart_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1159
+ command = make_simple_command(:post, 'v1/{+name}:restart', options)
1160
+ command.request_representation = Google::Apis::ManagedkafkaV1::RestartConnectorRequest::Representation
1161
+ command.request_object = restart_connector_request_object
1162
+ command.response_representation = Google::Apis::ManagedkafkaV1::RestartConnectorResponse::Representation
1163
+ command.response_class = Google::Apis::ManagedkafkaV1::RestartConnectorResponse
1164
+ command.params['name'] = name unless name.nil?
1165
+ command.query['fields'] = fields unless fields.nil?
1166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1167
+ execute_or_queue_command(command, &block)
1168
+ end
1169
+
1170
+ # Resumes the connector and its tasks.
1171
+ # @param [String] name
1172
+ # Required. The name of the connector to pause. Structured like: projects/`
1173
+ # project`/locations/`location`/connectClusters/`connectCluster`/connectors/`
1174
+ # connector`
1175
+ # @param [Google::Apis::ManagedkafkaV1::ResumeConnectorRequest] resume_connector_request_object
1176
+ # @param [String] fields
1177
+ # Selector specifying which fields to include in a partial response.
1178
+ # @param [String] quota_user
1179
+ # Available to use for quota purposes for server-side applications. Can be any
1180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1181
+ # @param [Google::Apis::RequestOptions] options
1182
+ # Request-specific options
1183
+ #
1184
+ # @yield [result, err] Result & error if block supplied
1185
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::ResumeConnectorResponse] parsed result object
1186
+ # @yieldparam err [StandardError] error object if request failed
1187
+ #
1188
+ # @return [Google::Apis::ManagedkafkaV1::ResumeConnectorResponse]
1189
+ #
1190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1193
+ def resume_connector(name, resume_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1194
+ command = make_simple_command(:post, 'v1/{+name}:resume', options)
1195
+ command.request_representation = Google::Apis::ManagedkafkaV1::ResumeConnectorRequest::Representation
1196
+ command.request_object = resume_connector_request_object
1197
+ command.response_representation = Google::Apis::ManagedkafkaV1::ResumeConnectorResponse::Representation
1198
+ command.response_class = Google::Apis::ManagedkafkaV1::ResumeConnectorResponse
1199
+ command.params['name'] = name unless name.nil?
1200
+ command.query['fields'] = fields unless fields.nil?
1201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1202
+ execute_or_queue_command(command, &block)
1203
+ end
1204
+
1205
+ # Stops the connector.
1206
+ # @param [String] name
1207
+ # Required. The name of the connector to stop. Structured like: projects/`
1208
+ # project`/locations/`location`/connectClusters/`connectCluster`/connectors/`
1209
+ # connector`
1210
+ # @param [Google::Apis::ManagedkafkaV1::StopConnectorRequest] stop_connector_request_object
1211
+ # @param [String] fields
1212
+ # Selector specifying which fields to include in a partial response.
1213
+ # @param [String] quota_user
1214
+ # Available to use for quota purposes for server-side applications. Can be any
1215
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1216
+ # @param [Google::Apis::RequestOptions] options
1217
+ # Request-specific options
1218
+ #
1219
+ # @yield [result, err] Result & error if block supplied
1220
+ # @yieldparam result [Google::Apis::ManagedkafkaV1::StopConnectorResponse] parsed result object
1221
+ # @yieldparam err [StandardError] error object if request failed
1222
+ #
1223
+ # @return [Google::Apis::ManagedkafkaV1::StopConnectorResponse]
1224
+ #
1225
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1226
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1227
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1228
+ def stop_connector(name, stop_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1229
+ command = make_simple_command(:post, 'v1/{+name}:stop', options)
1230
+ command.request_representation = Google::Apis::ManagedkafkaV1::StopConnectorRequest::Representation
1231
+ command.request_object = stop_connector_request_object
1232
+ command.response_representation = Google::Apis::ManagedkafkaV1::StopConnectorResponse::Representation
1233
+ command.response_class = Google::Apis::ManagedkafkaV1::StopConnectorResponse
1234
+ command.params['name'] = name unless name.nil?
1235
+ command.query['fields'] = fields unless fields.nil?
1236
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1237
+ execute_or_queue_command(command, &block)
1238
+ end
1239
+
680
1240
  # Starts asynchronous cancellation on a long-running operation. The server makes
681
1241
  # a best effort to cancel the operation, but success is not guaranteed. If the
682
1242
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-managedkafka_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-03-16 00:00:00.000000000 Z
10
+ date: 2025-04-16 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: google-apis-core
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-managedkafka_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-managedkafka_v1/v0.1.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-managedkafka_v1/v0.3.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-managedkafka_v1
62
62
  rdoc_options: []
63
63
  require_paths: