Google Cloud Support API . media

close()

Close httplib2 connections.

download(name, x__xgafv=None)

Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

Args:
  name: string, The name of the file attachment to download. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # # gdata.* are outside protos with mising documentation
  "algorithm": "A String", # # gdata.* are outside protos with mising documentation
  "bigstoreObjectRef": "A String", # # gdata.* are outside protos with mising documentation
  "blobRef": "A String", # # gdata.* are outside protos with mising documentation
  "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
    "blobId": "A String", # # gdata.* are outside protos with mising documentation
    "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
    "readToken": "A String", # # gdata.* are outside protos with mising documentation
    "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
  },
  "compositeMedia": [ # # gdata.* are outside protos with mising documentation
    { # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
  ],
  "contentType": "A String", # # gdata.* are outside protos with mising documentation
  "contentTypeInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "bestGuess": "A String", # # gdata.* are outside protos with mising documentation
    "fromBytes": "A String", # # gdata.* are outside protos with mising documentation
    "fromFileName": "A String", # # gdata.* are outside protos with mising documentation
    "fromHeader": "A String", # # gdata.* are outside protos with mising documentation
    "fromUrlPath": "A String", # # gdata.* are outside protos with mising documentation
  },
  "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
  "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
  "diffChecksumsResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "checksumsLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
    "chunkSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
    "objectLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
    "objectSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
    "objectVersion": "A String", # # gdata.* are outside protos with mising documentation
  },
  "diffDownloadResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "objectLocation": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
  },
  "diffUploadRequest": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "checksumsInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
    "objectInfo": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
    "objectVersion": "A String", # # gdata.* are outside protos with mising documentation
  },
  "diffUploadResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "objectVersion": "A String", # # gdata.* are outside protos with mising documentation
    "originalObject": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
      "blobRef": "A String", # # gdata.* are outside protos with mising documentation
      "blobstore2Info": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "blobGeneration": "A String", # # gdata.* are outside protos with mising documentation
        "blobId": "A String", # # gdata.* are outside protos with mising documentation
        "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation
        "readToken": "A String", # # gdata.* are outside protos with mising documentation
        "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation
      },
      "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation
      "crc32cHash": 42, # # gdata.* are outside protos with mising documentation
      "inline": "A String", # # gdata.* are outside protos with mising documentation
      "length": "A String", # # gdata.* are outside protos with mising documentation
      "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
      "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
        "bucketName": "A String", # # gdata.* are outside protos with mising documentation
        "generation": "A String", # # gdata.* are outside protos with mising documentation
        "objectName": "A String", # # gdata.* are outside protos with mising documentation
      },
      "path": "A String", # # gdata.* are outside protos with mising documentation
      "referenceType": "A String", # # gdata.* are outside protos with mising documentation
      "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
    },
  },
  "diffVersionResponse": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "objectSizeBytes": "A String", # # gdata.* are outside protos with mising documentation
    "objectVersion": "A String", # # gdata.* are outside protos with mising documentation
  },
  "downloadParameters": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "allowGzipCompression": True or False, # # gdata.* are outside protos with mising documentation
    "ignoreRange": True or False, # # gdata.* are outside protos with mising documentation
  },
  "filename": "A String", # # gdata.* are outside protos with mising documentation
  "hash": "A String", # # gdata.* are outside protos with mising documentation
  "hashVerified": True or False, # # gdata.* are outside protos with mising documentation
  "inline": "A String", # # gdata.* are outside protos with mising documentation
  "isPotentialRetry": True or False, # # gdata.* are outside protos with mising documentation
  "length": "A String", # # gdata.* are outside protos with mising documentation
  "md5Hash": "A String", # # gdata.* are outside protos with mising documentation
  "mediaId": "A String", # # gdata.* are outside protos with mising documentation
  "objectId": { # # gdata.* are outside protos with mising documentation # # gdata.* are outside protos with mising documentation
    "bucketName": "A String", # # gdata.* are outside protos with mising documentation
    "generation": "A String", # # gdata.* are outside protos with mising documentation
    "objectName": "A String", # # gdata.* are outside protos with mising documentation
  },
  "path": "A String", # # gdata.* are outside protos with mising documentation
  "referenceType": "A String", # # gdata.* are outside protos with mising documentation
  "sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
  "sha256Hash": "A String", # # gdata.* are outside protos with mising documentation
  "timestamp": "A String", # # gdata.* are outside protos with mising documentation
  "token": "A String", # # gdata.* are outside protos with mising documentation
}

download_media(name, x__xgafv=None)

Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```

Args:
  name: string, The name of the file attachment to download. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  The media object as a string.

    

upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

Args:
  parent: string, Required. The name of the case or Cloud resource to which the attachment should be attached. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for the CreateAttachment endpoint.
  "attachment": { # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a "case" level, not a "comment" level. # Required. The attachment to be created.
    "createTime": "A String", # Output only. The time at which the attachment was created.
    "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
      "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
      "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
      "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
      "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
    },
    "filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
    "mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
    "name": "A String", # Output only. The resource name of the attachment.
    "sizeBytes": "A String", # Output only. The size of the attachment in bytes.
  },
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a "case" level, not a "comment" level.
  "createTime": "A String", # Output only. The time at which the attachment was created.
  "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
    "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
    "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead.
    "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
    "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
  },
  "filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
  "mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
  "name": "A String", # Output only. The resource name of the attachment.
  "sizeBytes": "A String", # Output only. The size of the attachment in bytes.
}