Google Cloud Support API . cases . comments

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Add a new comment to the specified Case.

Args:
  parent: string, Required. The resource name of Case to which this comment should be added. (required)
  body: object, The request body.
    The object takes the form of:

{ # A comment associated with a support case.
  "body": "A String", # The full comment body. Maximum of 120000 characters. This can contain rich text syntax.
  "createTime": "A String", # Output only. The time when this comment was created.
  "creator": { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
    "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 credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
    "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
    "principalId": "A String", # Output only. An ID representing the user that was authenticated when the corresponding action was taken. This will be an email address, if one is available, or some other unique ID. See https://cloud.google.com/docs/authentication for more information on types of authentication.
  },
  "name": "A String", # Output only. The resource name for the comment.
  "plainTextBody": "A String", # Output only. An automatically generated plain text version of body with all rich text syntax stripped.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A comment associated with a support case.
  "body": "A String", # The full comment body. Maximum of 120000 characters. This can contain rich text syntax.
  "createTime": "A String", # Output only. The time when this comment was created.
  "creator": { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
    "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 credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
    "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
    "principalId": "A String", # Output only. An ID representing the user that was authenticated when the corresponding action was taken. This will be an email address, if one is available, or some other unique ID. See https://cloud.google.com/docs/authentication for more information on types of authentication.
  },
  "name": "A String", # Output only. The resource name for the comment.
  "plainTextBody": "A String", # Output only. An automatically generated plain text version of body with all rich text syntax stripped.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Retrieve all Comments associated with the Case object.

Args:
  parent: string, Required. The resource name of Case object for which comments should be listed. (required)
  pageSize: integer, The maximum number of comments fetched with each request. Defaults to 10.
  pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for the ListComments endpoint.
  "comments": [ # The list of Comments associated with the given Case.
    { # A comment associated with a support case.
      "body": "A String", # The full comment body. Maximum of 120000 characters. This can contain rich text syntax.
      "createTime": "A String", # Output only. The time when this comment was created.
      "creator": { # An object containing information about the effective user and authenticated principal responsible for an action. # Output only. The user or Google Support agent created this comment.
        "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 credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
        "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
        "principalId": "A String", # Output only. An ID representing the user that was authenticated when the corresponding action was taken. This will be an email address, if one is available, or some other unique ID. See https://cloud.google.com/docs/authentication for more information on types of authentication.
      },
      "name": "A String", # Output only. The resource name for the comment.
      "plainTextBody": "A String", # Output only. An automatically generated plain text version of body with all rich text syntax stripped.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCommentsRequest` message that is issued. If unspecified, there are no more results to retrieve.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.