Class FilesResource.PatchRequest
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
Inheritance
Inherited Members
Namespace: Google.Apis.Drive.v2
Assembly: Google.Apis.Drive.v2.dll
Syntax
public class FilesResource.PatchRequest : DriveBaseServiceRequest<File>, IClientServiceRequest<File>, IClientServiceRequest
Constructors
PatchRequest(IClientService, File, string)
Constructs a new Patch request.
Declaration
public PatchRequest(IClientService service, File body, string fileId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
File | body | |
string | fileId |
Properties
AddParents
Comma-separated list of parent IDs to add.
Declaration
[RequestParameter("addParents", RequestParameterType.Query)]
public virtual string AddParents { get; set; }
Property Value
Type | Description |
---|---|
string |
Convert
Deprecated: This parameter has no function.
Declaration
[RequestParameter("convert", RequestParameterType.Query)]
public virtual bool? Convert { get; set; }
Property Value
Type | Description |
---|---|
bool? |
EnforceSingleParent
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts
instead.
Declaration
[RequestParameter("enforceSingleParent", RequestParameterType.Query)]
public virtual bool? EnforceSingleParent { get; set; }
Property Value
Type | Description |
---|---|
bool? |
FileId
The ID of the file to update.
Declaration
[RequestParameter("fileId", RequestParameterType.Path)]
public virtual string FileId { get; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
IncludeLabels
A comma-separated list of IDs of labels to include in the labelInfo
part of the response.
Declaration
[RequestParameter("includeLabels", RequestParameterType.Query)]
public virtual string IncludeLabels { get; set; }
Property Value
Type | Description |
---|---|
string |
IncludePermissionsForView
Specifies which additional view's permissions to include in the response. Only published
is supported.
Declaration
[RequestParameter("includePermissionsForView", RequestParameterType.Query)]
public virtual string IncludePermissionsForView { get; set; }
Property Value
Type | Description |
---|---|
string |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ModifiedDateBehavior
Determines the behavior in which modifiedDate
is updated. This overrides setModifiedDate
.
Declaration
[RequestParameter("modifiedDateBehavior", RequestParameterType.Query)]
public virtual FilesResource.PatchRequest.ModifiedDateBehaviorEnum? ModifiedDateBehavior { get; set; }
Property Value
Type | Description |
---|---|
FilesResource.PatchRequest.ModifiedDateBehaviorEnum? |
NewRevision
Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request.
Declaration
[RequestParameter("newRevision", RequestParameterType.Query)]
public virtual bool? NewRevision { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Ocr
Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Declaration
[RequestParameter("ocr", RequestParameterType.Query)]
public virtual bool? Ocr { get; set; }
Property Value
Type | Description |
---|---|
bool? |
OcrLanguage
If ocr is true, hints at the language to use. Valid values are BCP 47 codes.
Declaration
[RequestParameter("ocrLanguage", RequestParameterType.Query)]
public virtual string OcrLanguage { get; set; }
Property Value
Type | Description |
---|---|
string |
Pinned
Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request.
Declaration
[RequestParameter("pinned", RequestParameterType.Query)]
public virtual bool? Pinned { get; set; }
Property Value
Type | Description |
---|---|
bool? |
RemoveParents
Comma-separated list of parent IDs to remove.
Declaration
[RequestParameter("removeParents", RequestParameterType.Query)]
public virtual string RemoveParents { get; set; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
SetModifiedDate
Whether to set the modified date using the value supplied in the request body. Setting this field to
true
is equivalent to modifiedDateBehavior=fromBodyOrNow
, and false
is equivalent to
modifiedDateBehavior=now
. To prevent any changes to the modified date set
modifiedDateBehavior=noChange
.
Declaration
[RequestParameter("setModifiedDate", RequestParameterType.Query)]
public virtual bool? SetModifiedDate { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportsAllDrives
Whether the requesting application supports both My Drives and shared drives.
Declaration
[RequestParameter("supportsAllDrives", RequestParameterType.Query)]
public virtual bool? SupportsAllDrives { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SupportsTeamDrives
Deprecated: Use supportsAllDrives
instead.
Declaration
[RequestParameter("supportsTeamDrives", RequestParameterType.Query)]
public virtual bool? SupportsTeamDrives { get; set; }
Property Value
Type | Description |
---|---|
bool? |
TimedTextLanguage
The language of the timed text.
Declaration
[RequestParameter("timedTextLanguage", RequestParameterType.Query)]
public virtual string TimedTextLanguage { get; set; }
Property Value
Type | Description |
---|---|
string |
TimedTextTrackName
The timed text track name.
Declaration
[RequestParameter("timedTextTrackName", RequestParameterType.Query)]
public virtual string TimedTextTrackName { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateViewedDate
Whether to update the view date after successfully updating the file.
Declaration
[RequestParameter("updateViewedDate", RequestParameterType.Query)]
public virtual bool? UpdateViewedDate { get; set; }
Property Value
Type | Description |
---|---|
bool? |
UseContentAsIndexableText
Whether to use the content as indexable text.
Declaration
[RequestParameter("useContentAsIndexableText", RequestParameterType.Query)]
public virtual bool? UseContentAsIndexableText { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Patch parameter list.
Declaration
protected override void InitParameters()