patch method

Future<Object> patch(Object request, String bucket, String object, { String? generation, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, bool? overrideUnlockedRetention, String? predefinedAcl, String? projection, String? userProject, String? $fields, })

Patches an object's metadata.

request - The metadata request object.

Request parameters:

bucket - Name of the bucket in which the object resides.

object - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

generation - If present, selects a specific revision of this object (as opposed to the latest version, the default).

ifGenerationMatch - Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

ifGenerationNotMatch - Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

ifMetagenerationMatch - Makes the operation conditional on whether the object's current metageneration matches the given value.

ifMetagenerationNotMatch - Makes the operation conditional on whether the object's current metageneration does not match the given value.

overrideUnlockedRetention - Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.

predefinedAcl - Apply a predefined set of access controls to this object. Possible string values are:

• "authenticatedRead" : Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
• "bucketOwnerFullControl" : Object owner gets OWNER access, and project team owners get OWNER access.
• "bucketOwnerRead" : Object owner gets OWNER access, and project team owners get READER access.
• "private" : Object owner gets OWNER access.
• "projectPrivate" : Object owner gets OWNER access, and project team members get access according to their roles.
• "publicRead" : Object owner gets OWNER access, and allUsers get READER access.

projection - Set of properties to return. Defaults to full. Possible string values are:

• "full" : Include all properties.
• "noAcl" : Omit the owner, acl property.

userProject - The project to be billed for this request, for Requester Pays buckets.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Object.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Object> patch(
  Object request,
  core.String bucket,
  core.String object, {
  core.String? generation,
  core.String? ifGenerationMatch,
  core.String? ifGenerationNotMatch,
  core.String? ifMetagenerationMatch,
  core.String? ifMetagenerationNotMatch,
  core.bool? overrideUnlockedRetention,
  core.String? predefinedAcl,
  core.String? projection,
  core.String? userProject,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'generation': ?generation == null ? null : [generation],
    'ifGenerationMatch': ?ifGenerationMatch == null
        ? null
        : [ifGenerationMatch],
    'ifGenerationNotMatch': ?ifGenerationNotMatch == null
        ? null
        : [ifGenerationNotMatch],
    'ifMetagenerationMatch': ?ifMetagenerationMatch == null
        ? null
        : [ifMetagenerationMatch],
    'ifMetagenerationNotMatch': ?ifMetagenerationNotMatch == null
        ? null
        : [ifMetagenerationNotMatch],
    'overrideUnlockedRetention': ?overrideUnlockedRetention == null
        ? null
        : ['${overrideUnlockedRetention}'],
    'predefinedAcl': ?predefinedAcl == null ? null : [predefinedAcl],
    'projection': ?projection == null ? null : [projection],
    'userProject': ?userProject == null ? null : [userProject],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'b/' +
      commons.escapeVariable('$bucket') +
      '/o/' +
      commons.escapeVariable('$object');

  final response_ = await _requester.request(
    url_,
    'PATCH',
    body: body_,
    queryParams: queryParams_,
  );
  return Object.fromJson(response_ as core.Map<core.String, core.dynamic>);
}