Package types (0.1.16)

API documentation for support_v2beta.types package.

Classes

Actor

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.

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.

Case

A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time.

A case is parented by a Google Cloud organization or project.

Organizations are identified by a number, so the name of a case parented by an organization would look like this:

::

organizations/123/cases/456

Projects have two unique identifiers, an ID and a number, and they look like this:

::

projects/abc/cases/456

::

projects/123/cases/456

You can use either of them when calling the API. To learn more about project identifiers, see AIP-2510 <https://google.aip.dev/cloud/2510>__.

CaseClassification

A Case Classification represents the topic that a case is about. It's very important to use accurate classifications, because they're used to route your cases to specialists who can help you.

A classification always has an ID that is its unique identifier. A valid ID is required when creating a case.

CloseCaseRequest

The request message for the CloseCase endpoint.

Comment

A comment associated with a support case.

Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.

CreateCaseRequest

The request message for the CreateCase endpoint.

CreateCommentRequest

The request message for the CreateComment endpoint.

EmailMessage

An email associated with a support case.

EscalateCaseRequest

The request message for the EscalateCase endpoint.

Escalation

An escalation of a support case.

FeedItem

A feed item associated with a support case.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GetCaseRequest

The request message for the GetCase endpoint.

ListAttachmentsRequest

The request message for the ListAttachments endpoint.

ListAttachmentsResponse

The response message for the ListAttachments endpoint.

ListCasesRequest

The request message for the ListCases endpoint.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCasesResponse

The response message for the ListCases endpoint.

ListCommentsRequest

The request message for the ListComments endpoint.

ListCommentsResponse

The response message for the ListComments endpoint.

Product

The product a case may be associated with.

ProductLine

The product line a support case may be associated with.

SearchCaseClassificationsRequest

The request message for the SearchCaseClassifications endpoint.

SearchCaseClassificationsResponse

The response message for SearchCaseClassifications endpoint.

SearchCasesRequest

The request message for the SearchCases endpoint.

SearchCasesResponse

The response message for the SearchCases endpoint.

ShowFeedRequest

The request message for the ShowFeed endpoint.

ShowFeedResponse

The response message for the ShowFeed endpoint.

TextContent

Stores text attached to a support object.

UpdateCaseRequest

The request message for the UpdateCase endpoint