google-apis-vmwareengine_v1 0.7.0 → 0.9.0

data/lib/google/apis/vmwareengine_v1/service.rb

@@ -162,6 +162,103 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieves a `Announcement` by its resource name.
+        # @param [String] name
+        #   Required. The resource name of the announcement to retrieve. Resource names
+        #   are schemeless URIs that follow the conventions in https://cloud.google.com/
+        #   apis/design/resource_names. For example: `projects/my-project/locations/us-
+        #   west1-a/announcements/announcement-uuid`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::VmwareengineV1::Announcement] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::VmwareengineV1::Announcement]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_announcement(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::VmwareengineV1::Announcement::Representation
+          command.response_class = Google::Apis::VmwareengineV1::Announcement
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists `Announcements` for a given region and project
+        # @param [String] parent
+        #   Required. The resource name of the location to be queried for announcements.
+        #   Resource names are schemeless URIs that follow the conventions in https://
+        #   cloud.google.com/apis/design/resource_names. For example: `projects/my-project/
+        #   locations/us-west1-a`
+        # @param [String] filter
+        #   A filter expression that matches resources returned in the response. The
+        #   expression must specify the field name, a comparison operator, and the value
+        #   that you want to use for filtering. The value must be a string, a number, or a
+        #   boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example,
+        #   if you are filtering a list of announcement runs, you can exclude the ones
+        #   named `example-announcement` by specifying `name != "example-announcement"`.
+        #   You can also filter nested fields. To filter on multiple expressions, provide
+        #   each separate expression within parentheses. For example: ``` (name = "example-
+        #   announcement") (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each
+        #   expression is an `AND` expression. However, you can include `AND` and `OR`
+        #   expressions explicitly. For example: ``` (name = "announcement-1") AND (
+        #   createTime > "2021-04-12T08:15:10.40Z") OR (name = "announcement-2") ```
+        # @param [String] order_by
+        #   Sorts list results by a certain order. By default, returned results are
+        #   ordered by `name` in ascending order. You can also sort results in descending
+        #   order based on the `name` value using `orderBy="name desc"`. Currently, only
+        #   ordering by `name` is supported.
+        # @param [Fixnum] page_size
+        #   The maximum number of announcements to return in one page. The service may
+        #   return fewer than this value. The maximum value is coerced to 1000. The
+        #   default value of this field is 500.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListAnnouncements` call. Provide this
+        #   to retrieve the subsequent page. When paginating, all other parameters
+        #   provided to `ListAnnouncements` must match the call that provided the page
+        #   token.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::VmwareengineV1::ListAnnouncementsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::VmwareengineV1::ListAnnouncementsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_announcements(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/announcements', options)
+          command.response_representation = Google::Apis::VmwareengineV1::ListAnnouncementsResponse::Representation
+          command.response_class = Google::Apis::VmwareengineV1::ListAnnouncementsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Grants the bind permission to the customer provided principal(user / service
         # account) to bind their DNS zone with the intranet VPC associated with the
         # project. DnsBindPermission is a global resource and location can only be
@@ -457,11 +554,11 @@ module Google
         # updated. Only fields specified in `updateMask` are applied. NetworkPeering is
         # a global resource and location can only be global.
         # @param [String] name
-        #   Output only. The resource name of the network peering. NetworkPeering is a
-        #   global resource and location can only be global. Resource names are scheme-
-        #   less URIs that follow the conventions in https://cloud.google.com/apis/design/
-        #   resource_names. For example: `projects/my-project/locations/global/
-        #   networkPeerings/my-peering`
+        #   Output only. Identifier. The resource name of the network peering.
+        #   NetworkPeering is a global resource and location can only be global. Resource
+        #   names are scheme-less URIs that follow the conventions in https://cloud.google.
+        #   com/apis/design/resource_names. For example: `projects/my-project/locations/
+        #   global/networkPeerings/my-peering`
         # @param [Google::Apis::VmwareengineV1::NetworkPeering] network_peering_object
         # @param [String] request_id
         #   Optional. A request ID to identify requests. Specify a unique request ID so
@@ -825,10 +922,10 @@ module Google
         # resource. Use the operation status to determine when the processing fully
         # completes.
         # @param [String] name
-        #   Output only. The resource name of this network policy. Resource names are
-        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
-        #   design/resource_names. For example: `projects/my-project/locations/us-central1/
-        #   networkPolicies/my-network-policy`
+        #   Output only. Identifier. The resource name of this network policy. Resource
+        #   names are schemeless URIs that follow the conventions in https://cloud.google.
+        #   com/apis/design/resource_names. For example: `projects/my-project/locations/us-
+        #   central1/networkPolicies/my-network-policy`
         # @param [Google::Apis::VmwareengineV1::NetworkPolicy] network_policy_object
         # @param [String] request_id
         #   Optional. A request ID to identify requests. Specify a unique request ID so
@@ -1635,10 +1732,10 @@ module Google
         # resource. Use the operation status to determine when the processing fully
         # completes.
         # @param [String] name
-        #   Output only. The resource name of this private cloud. Resource names are
-        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
-        #   design/resource_names. For example: `projects/my-project/locations/us-central1-
-        #   a/privateClouds/my-cloud`
+        #   Output only. Identifier. The resource name of this private cloud. Resource
+        #   names are schemeless URIs that follow the conventions in https://cloud.google.
+        #   com/apis/design/resource_names. For example: `projects/my-project/locations/us-
+        #   central1-a/privateClouds/my-cloud`
         # @param [Google::Apis::VmwareengineV1::PrivateCloud] private_cloud_object
         # @param [String] request_id
         #   Optional. The request ID must be a valid UUID with the exception that zero
@@ -1943,10 +2040,10 @@ module Google
         # Updates the parameters of the `DnsForwarding` config, like associated domains.
         # Only fields specified in `update_mask` are applied.
         # @param [String] name
-        #   Output only. The resource name of this DNS profile. Resource names are
-        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
-        #   design/resource_names. For example: `projects/my-project/locations/us-central1-
-        #   a/privateClouds/my-cloud/dnsForwarding`
+        #   Output only. Identifier. The resource name of this DNS profile. Resource names
+        #   are schemeless URIs that follow the conventions in https://cloud.google.com/
+        #   apis/design/resource_names. For example: `projects/my-project/locations/us-
+        #   central1-a/privateClouds/my-cloud/dnsForwarding`
         # @param [Google::Apis::VmwareengineV1::DnsForwarding] dns_forwarding_object
         # @param [String] request_id
         #   Optional. A request ID to identify requests. Specify a unique request ID so
@@ -2232,10 +2329,10 @@ module Google
         # you can't update the resource. Use the operation status to determine when the
         # processing fully completes.
         # @param [String] name
-        #   Output only. The resource name of this cluster. Resource names are schemeless
-        #   URIs that follow the conventions in https://cloud.google.com/apis/design/
-        #   resource_names. For example: `projects/my-project/locations/us-central1-a/
-        #   privateClouds/my-cloud/clusters/my-cluster`
+        #   Output only. Identifier. The resource name of this cluster. Resource names are
+        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
+        #   design/resource_names. For example: `projects/my-project/locations/us-central1-
+        #   a/privateClouds/my-cloud/clusters/my-cluster`
         # @param [Google::Apis::VmwareengineV1::Cluster] cluster_object
         # @param [String] request_id
         #   Optional. The request ID must be a valid UUID with the exception that zero
@@ -2643,10 +2740,10 @@ module Google
         # that period of time, you can't update the resource. Use the operation status
         # to determine when the processing fully completes.
         # @param [String] name
-        #   Output only. The resource name of this external IP address. Resource names are
-        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
-        #   design/resource_names. For example: `projects/my-project/locations/us-central1-
-        #   a/privateClouds/my-cloud/externalAddresses/my-address`
+        #   Output only. Identifier. The resource name of this external IP address.
+        #   Resource names are schemeless URIs that follow the conventions in https://
+        #   cloud.google.com/apis/design/resource_names. For example: `projects/my-project/
+        #   locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`
         # @param [Google::Apis::VmwareengineV1::ExternalAddress] external_address_object
         # @param [String] request_id
         #   Optional. A request ID to identify requests. Specify a unique request ID so
@@ -3602,10 +3699,10 @@ module Google
         # successful `google.longrunning.Operation` (LRO). The returned LRO will only
         # have `done` and `response` fields.
         # @param [String] name
-        #   Output only. The resource name of this subnet. Resource names are schemeless
-        #   URIs that follow the conventions in https://cloud.google.com/apis/design/
-        #   resource_names. For example: `projects/my-project/locations/us-central1-a/
-        #   privateClouds/my-cloud/subnets/my-subnet`
+        #   Output only. Identifier. The resource name of this subnet. Resource names are
+        #   schemeless URIs that follow the conventions in https://cloud.google.com/apis/
+        #   design/resource_names. For example: `projects/my-project/locations/us-central1-
+        #   a/privateClouds/my-cloud/subnets/my-subnet`
         # @param [Google::Apis::VmwareengineV1::Subnet] subnet_object
         # @param [String] update_mask
         #   Required. Field mask is used to specify the fields to be overwritten in the `
@@ -3643,6 +3740,161 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Retrieves a private cloud `Upgrade` resource by its resource name.
+        # @param [String] name
+        #   Required. The name of the `Upgrade` resource to be retrieved. Resource names
+        #   are schemeless URIs that follow the conventions in https://cloud.google.com/
+        #   apis/design/resource_names. For example: `projects/my-project/locations/us-
+        #   west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::VmwareengineV1::Upgrade] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::VmwareengineV1::Upgrade]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_private_cloud_upgrade(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::VmwareengineV1::Upgrade::Representation
+          command.response_class = Google::Apis::VmwareengineV1::Upgrade
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists past, ongoing and upcoming `Upgrades` for the given private cloud.
+        # @param [String] parent
+        #   Required. Query a list of `Upgrades` for the given private cloud resource name.
+        #   Resource names are schemeless URIs that follow the conventions in https://
+        #   cloud.google.com/apis/design/resource_names. For example: `projects/my-project/
+        #   locations/us-west1-a/privateClouds/my-cloud`
+        # @param [String] filter
+        #   A filter expression that matches resources returned in the response. The
+        #   expression must specify the field name, a comparison operator, and the value
+        #   that you want to use for filtering. The value must be a string, a number, or a
+        #   boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example,
+        #   if you are filtering a list of upgrades, you can exclude the ones named `
+        #   example-upgrade1` by specifying `name != "example-upgrade1"`. You can also
+        #   filter nested fields. To filter on multiple expressions, provide each separate
+        #   expression within parentheses. For example: ``` (name = "example-upgrade") (
+        #   createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `
+        #   AND` expression. However, you can include `AND` and `OR` expressions
+        #   explicitly. For example: ``` (name = "upgrade-1") AND (createTime > "2021-04-
+        #   12T08:15:10.40Z") OR (name = "upgrade-2") ```
+        # @param [String] order_by
+        #   Sorts list results by a certain order. By default, returned results are
+        #   ordered by `name` in ascending order. You can also sort results in descending
+        #   order based on the `name` value using `orderBy="name desc"`. Currently, only
+        #   ordering by `name` is supported.
+        # @param [Fixnum] page_size
+        #   The maximum number of `Upgrades` to return in one page. The service may return
+        #   fewer resources than this value. The maximum value is coerced to 1000. The
+        #   default value of this field is 500.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListUpgrades` call. Provide this to
+        #   retrieve the subsequent page. When paginating, all other parameters provided
+        #   to `ListUpgrades` must match the call that provided the page token.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::VmwareengineV1::ListUpgradesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::VmwareengineV1::ListUpgradesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_private_cloud_upgrades(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/upgrades', options)
+          command.response_representation = Google::Apis::VmwareengineV1::ListUpgradesResponse::Representation
+          command.response_class = Google::Apis::VmwareengineV1::ListUpgradesResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Update the private cloud `Upgrade` resource. Only `schedule` field can updated.
+        # The schedule can only be updated when the upgrade has not started and
+        # schedule edit window is open. Only fields specified in `update_mask` are
+        # considered.
+        # @param [String] name
+        #   Output only. Identifier. The resource name of the private cloud `Upgrade`.
+        #   Resource names are schemeless URIs that follow the conventions in https://
+        #   cloud.google.com/apis/design/resource_names. For example: `projects/my-project/
+        #   locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade`
+        # @param [Google::Apis::VmwareengineV1::Upgrade] upgrade_object
+        # @param [String] request_id
+        #   Optional. A request ID to identify requests. Specify a unique request ID so
+        #   that if you must retry your request, the server will know to ignore the
+        #   request if it has already been completed. The server guarantees that a request
+        #   doesn't result in creation of duplicate commitments for at least 60 minutes.
+        #   For example, consider a situation where you make an initial request and the
+        #   request times out. If you make the request again with the same request ID, the
+        #   server can check if original operation with the same request ID was received,
+        #   and if so, will ignore the second request. This prevents clients from
+        #   accidentally creating duplicate commitments. The request ID must be a valid
+        #   UUID with the exception that zero UUID is not supported (00000000-0000-0000-
+        #   0000-000000000000).
+        # @param [String] update_mask
+        #   Required. Field mask is used to specify the fields to be overwritten in the `
+        #   Upgrade` resource by the update. The fields specified in the `update_mask` are
+        #   relative to the resource, not the full request. A field will be overwritten if
+        #   it is in the mask. If the user does not provide a mask then all fields will be
+        #   overwritten.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::VmwareengineV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::VmwareengineV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_project_location_private_cloud_upgrade(name, upgrade_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/{+name}', options)
+          command.request_representation = Google::Apis::VmwareengineV1::Upgrade::Representation
+          command.request_object = upgrade_object
+          command.response_representation = Google::Apis::VmwareengineV1::Operation::Representation
+          command.response_class = Google::Apis::VmwareengineV1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['requestId'] = request_id unless request_id.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a new private connection that can be used for accessing private Clouds.
         # @param [String] parent
         #   Required. The resource name of the location to create the new private
@@ -4168,10 +4420,10 @@ module Google
         # Modifies a VMware Engine network resource. Only the following fields can be
         # updated: `description`. Only fields specified in `updateMask` are applied.
         # @param [String] name
-        #   Output only. The resource name of the VMware Engine network. Resource names
-        #   are schemeless URIs that follow the conventions in https://cloud.google.com/
-        #   apis/design/resource_names. For example: `projects/my-project/locations/global/
-        #   vmwareEngineNetworks/my-network`
+        #   Output only. Identifier. The resource name of the VMware Engine network.
+        #   Resource names are schemeless URIs that follow the conventions in https://
+        #   cloud.google.com/apis/design/resource_names. For example: `projects/my-project/
+        #   locations/global/vmwareEngineNetworks/my-network`
         # @param [Google::Apis::VmwareengineV1::VmwareEngineNetwork] vmware_engine_network_object
         # @param [String] request_id
         #   Optional. A request ID to identify requests. Specify a unique request ID so

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-vmwareengine_v1
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,9 +57,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-vmwareengine_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-vmwareengine_v1/v0.7.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-vmwareengine_v1/v0.9.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-vmwareengine_v1
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Simple REST client for VMware Engine API V1
 test_files: []