generated/google-apis-cloudchannel_v1/lib/google/apis/cloudchannel_v1/service.rb
# Cancels a previously fulfilled entitlement. An entitlement cancellation is a
# long-running operation. Possible error codes: * PERMISSION_DENIED: The
# reseller account making the request is different from the reseller account in
# the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked
# to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT:
# Required request parameters are missing or invalid. * NOT_FOUND: Entitlement
# resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for
# Google Workspace add-ons, or entitlements for Google Cloud's development
# platform. * INTERNAL: Any non-user error related to a technical issue in the
# backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related
# to a technical issue in the backend. Contact Cloud Channel support. Return
# value: The ID of a long-running operation. To get the results of the operation,
# call the GetOperation method of CloudChannelOperationsService. The response
# will contain google.protobuf.Empty on success. The Operation metadata will
# contain an instance of OperationMetadata.
# @param [String] name
#   Required. The resource name of the entitlement to cancel. Name uses the format:
#   accounts/`account_id`/customers/`customer_id`/entitlements/`entitlement_id`
# @param [Google::Apis::CloudchannelV1::GoogleCloudChannelV1CancelEntitlementRequest] google_cloud_channel_v1_cancel_entitlement_request_object
# @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::CloudchannelV1::GoogleLongrunningOperation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudchannelV1::GoogleLongrunningOperation]
#
# @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
Cancels a previously fulfilled entitlement. An entitlement cancellation is a
long-running operation. Possible error codes: * PERMISSION_DENIED: The
reseller account making the request is different from the reseller account in
the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked
to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT:
Required request parameters are missing or invalid. * NOT_FOUND: Entitlement
resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for
Google Workspace add-ons, or entitlements for Google Cloud's development
platform. * INTERNAL: Any non-user error related to a technical issue in the
backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related
to a technical issue in the backend. Contact Cloud Channel support. Return
value: The ID of a long-running operation. To get the results of the operation,
call the GetOperation method of CloudChannelOperationsService. The response
will contain google.protobuf.Empty on success. The Operation metadata will
contain an instance of OperationMetadata.
Cancels a previously fulfilled entitlement . An entitlement cancellation is a long - running operation . Possible error codes : * PERMISSION_DENIED : The reseller account making the request is different from the reseller account in the API request . * FAILED_PRECONDITION : There are Google Cloud projects linked to the Google Cloud entitlement ' s Cloud Billing subaccount . * INVALID_ARGUMENT : Required request parameters are missing or invalid . * NOT_FOUND : Entitlement resource not found . * DELETION_TYPE_NOT_ALLOWED : Cancel is only allowed for Google Workspace add - ons or entitlements for Google Cloud ' s development platform . * INTERNAL : Any non - user error related to a technical issue in the backend . Contact Cloud Channel support . * UNKNOWN : Any non - user error related to a technical issue in the backend . Contact Cloud Channel support . Return value : The ID of a long - running operation . To get the results of the operation call the GetOperation method of CloudChannelOperationsService . The response will contain google . protobuf . Empty on success . The Operation metadata will contain an instance of OperationMetadata .
def cancel_account_customer_entitlement(name, google_cloud_channel_v1_cancel_entitlement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1/{+name}:cancel', options)
          command.request_representation = Google::Apis::CloudchannelV1::GoogleCloudChannelV1CancelEntitlementRequest::Representation
          command.request_object = google_cloud_channel_v1_cancel_entitlement_request_object
          command.response_representation = Google::Apis::CloudchannelV1::GoogleLongrunningOperation::Representation
          command.response_class = Google::Apis::CloudchannelV1::GoogleLongrunningOperation
          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
def cancel_account_customer_entitlement ( name , google_cloud_channel_v1_cancel_entitlement_request_object = nil , fields : nil , quota_user : nil , options : nil , & block ) command = make_simple_command ( :post , 'v1/{+name}:cancel' , options ) command . request_representation = Google :: Apis :: CloudchannelV1 :: GoogleCloudChannelV1CancelEntitlementRequest :: Representation command . request_object = google_cloud_channel_v1_cancel_entitlement_request_object command . response_representation = Google :: Apis :: CloudchannelV1 :: GoogleLongrunningOperation :: Representation command . response_class = Google :: Apis :: CloudchannelV1 :: GoogleLongrunningOperation 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
Cancels a previously fulfilled entitlement.
Cancels a previously fulfilled entitlement .
None
Google::Apis::CloudchannelV1::GoogleLongrunningOperation
[Google::Apis::ServerError] An error occurred on the server and the request can be retried
[ Google :: Apis :: ServerError ] An error occurred on the server and the request can be retried
[Google::Apis::ClientError] The request is invalid and should not be retried without modification
[ Google :: Apis :: ClientError ] The request is invalid and should not be retried without modification
[Google::Apis::AuthorizationError] Authorization is required
[ Google :: Apis :: AuthorizationError ] Authorization is required
name
google_cloud_channel_v1_cancel_entitlement_request_object
fields
quota_user
options
block
options Request-specific options
options Request - specific options
]
Result & error if block supplied
Result & error if block supplied
result
parsed result object
parsed result object
err
error object if request failed
error object if request failed