cloudsupport
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package cloudsupport provides access to the Google Cloud Support API.
For product documentation, see:https://cloud.google.com/support/docs/apis
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/cloudsupport/v2"...ctx := context.Background()cloudsupportService, err := cloudsupport.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
cloudsupportService, err := cloudsupport.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)cloudsupportService, err := cloudsupport.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type Actor
- type Attachment
- type Blobstore2Info
- type Case
- type CaseClassification
- type CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) Context(ctx context.Context) *CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchCaseClassificationsResponse, error)
- func (c *CaseClassificationsSearchCall) Fields(s ...googleapi.Field) *CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) Header() http.Header
- func (c *CaseClassificationsSearchCall) IfNoneMatch(entityTag string) *CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) PageSize(pageSize int64) *CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) PageToken(pageToken string) *CaseClassificationsSearchCall
- func (c *CaseClassificationsSearchCall) Pages(ctx context.Context, f func(*SearchCaseClassificationsResponse) error) error
- func (c *CaseClassificationsSearchCall) Query(query string) *CaseClassificationsSearchCall
- type CaseClassificationsService
- type CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) Context(ctx context.Context) *CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAttachmentsResponse, error)
- func (c *CasesAttachmentsListCall) Fields(s ...googleapi.Field) *CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) Header() http.Header
- func (c *CasesAttachmentsListCall) IfNoneMatch(entityTag string) *CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) PageSize(pageSize int64) *CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) PageToken(pageToken string) *CasesAttachmentsListCall
- func (c *CasesAttachmentsListCall) Pages(ctx context.Context, f func(*ListAttachmentsResponse) error) error
- type CasesAttachmentsService
- type CasesCloseCall
- type CasesCommentsCreateCall
- func (c *CasesCommentsCreateCall) Context(ctx context.Context) *CasesCommentsCreateCall
- func (c *CasesCommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment, error)
- func (c *CasesCommentsCreateCall) Fields(s ...googleapi.Field) *CasesCommentsCreateCall
- func (c *CasesCommentsCreateCall) Header() http.Header
- type CasesCommentsListCall
- func (c *CasesCommentsListCall) Context(ctx context.Context) *CasesCommentsListCall
- func (c *CasesCommentsListCall) Do(opts ...googleapi.CallOption) (*ListCommentsResponse, error)
- func (c *CasesCommentsListCall) Fields(s ...googleapi.Field) *CasesCommentsListCall
- func (c *CasesCommentsListCall) Header() http.Header
- func (c *CasesCommentsListCall) IfNoneMatch(entityTag string) *CasesCommentsListCall
- func (c *CasesCommentsListCall) PageSize(pageSize int64) *CasesCommentsListCall
- func (c *CasesCommentsListCall) PageToken(pageToken string) *CasesCommentsListCall
- func (c *CasesCommentsListCall) Pages(ctx context.Context, f func(*ListCommentsResponse) error) error
- type CasesCommentsService
- type CasesCreateCall
- type CasesEscalateCall
- type CasesGetCall
- func (c *CasesGetCall) Context(ctx context.Context) *CasesGetCall
- func (c *CasesGetCall) Do(opts ...googleapi.CallOption) (*Case, error)
- func (c *CasesGetCall) Fields(s ...googleapi.Field) *CasesGetCall
- func (c *CasesGetCall) Header() http.Header
- func (c *CasesGetCall) IfNoneMatch(entityTag string) *CasesGetCall
- type CasesListCall
- func (c *CasesListCall) Context(ctx context.Context) *CasesListCall
- func (c *CasesListCall) Do(opts ...googleapi.CallOption) (*ListCasesResponse, error)
- func (c *CasesListCall) Fields(s ...googleapi.Field) *CasesListCall
- func (c *CasesListCall) Filter(filter string) *CasesListCall
- func (c *CasesListCall) Header() http.Header
- func (c *CasesListCall) IfNoneMatch(entityTag string) *CasesListCall
- func (c *CasesListCall) PageSize(pageSize int64) *CasesListCall
- func (c *CasesListCall) PageToken(pageToken string) *CasesListCall
- func (c *CasesListCall) Pages(ctx context.Context, f func(*ListCasesResponse) error) error
- type CasesPatchCall
- func (c *CasesPatchCall) Context(ctx context.Context) *CasesPatchCall
- func (c *CasesPatchCall) Do(opts ...googleapi.CallOption) (*Case, error)
- func (c *CasesPatchCall) Fields(s ...googleapi.Field) *CasesPatchCall
- func (c *CasesPatchCall) Header() http.Header
- func (c *CasesPatchCall) UpdateMask(updateMask string) *CasesPatchCall
- type CasesSearchCall
- func (c *CasesSearchCall) Context(ctx context.Context) *CasesSearchCall
- func (c *CasesSearchCall) Do(opts ...googleapi.CallOption) (*SearchCasesResponse, error)
- func (c *CasesSearchCall) Fields(s ...googleapi.Field) *CasesSearchCall
- func (c *CasesSearchCall) Header() http.Header
- func (c *CasesSearchCall) IfNoneMatch(entityTag string) *CasesSearchCall
- func (c *CasesSearchCall) PageSize(pageSize int64) *CasesSearchCall
- func (c *CasesSearchCall) PageToken(pageToken string) *CasesSearchCall
- func (c *CasesSearchCall) Pages(ctx context.Context, f func(*SearchCasesResponse) error) error
- func (c *CasesSearchCall) Query(query string) *CasesSearchCall
- type CasesService
- func (r *CasesService) Close(name string, closecaserequest *CloseCaseRequest) *CasesCloseCall
- func (r *CasesService) Create(parent string, case_ *Case) *CasesCreateCall
- func (r *CasesService) Escalate(name string, escalatecaserequest *EscalateCaseRequest) *CasesEscalateCall
- func (r *CasesService) Get(name string) *CasesGetCall
- func (r *CasesService) List(parent string) *CasesListCall
- func (r *CasesService) Patch(name string, case_ *Case) *CasesPatchCall
- func (r *CasesService) Search(parent string) *CasesSearchCall
- type CloseCaseRequest
- type Comment
- type CompositeMedia
- type ContentTypeInfo
- type CreateAttachmentRequest
- type DiffChecksumsResponse
- type DiffDownloadResponse
- type DiffUploadRequest
- type DiffUploadResponse
- type DiffVersionResponse
- type DownloadParameters
- type EscalateCaseRequest
- type Escalation
- type ListAttachmentsResponse
- type ListCasesResponse
- type ListCommentsResponse
- type Media
- type MediaDownloadCall
- func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall
- func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*Media, error)
- func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
- func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
- func (c *MediaDownloadCall) Header() http.Header
- func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall
- type MediaService
- type MediaUploadCall
- func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall
- func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*Attachment, error)
- func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
- func (c *MediaUploadCall) Header() http.Header
- func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall
- func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall
- func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCalldeprecated
- type ObjectId
- type SearchCaseClassificationsResponse
- type SearchCasesResponse
- type Service
Constants¶
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeActor¶
type Actor struct {// DisplayName: 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.DisplayNamestring `json:"displayName,omitempty"`// Email: 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` instead.Emailstring `json:"email,omitempty"`// GoogleSupport: Output only. Whether the actor is a Google support actor.GoogleSupportbool `json:"googleSupport,omitempty"`// Username: 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.Usernamestring `json:"username,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}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 whouploaded an attachment, or a service account that created a support case.
func (Actor)MarshalJSON¶
typeAttachment¶
type Attachment struct {// CreateTime: Output only. The time at which the attachment was created.CreateTimestring `json:"createTime,omitempty"`// Creator: Output only. The user who uploaded the attachment. Note, the name// and email will be obfuscated if the attachment was uploaded by Google// support.Creator *Actor `json:"creator,omitempty"`// Filename: The filename of the attachment (e.g. "graph.jpg").Filenamestring `json:"filename,omitempty"`// MimeType: Output only. The MIME type of the attachment (e.g. text/plain).MimeTypestring `json:"mimeType,omitempty"`// Name: Output only. Identifier. The resource name of the attachment.Namestring `json:"name,omitempty"`// SizeBytes: Output only. The size of the attachment in bytes.SizeBytesint64 `json:"sizeBytes,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Attachment: An Attachment contains metadata about a file that was uploadedto a case - it is NOT a file itself. That being said, the name of anAttachment object can be used to download its accompanying file through the`media.download` endpoint. While attachments can be uploaded in the consoleat the same time as a comment, they're associated on a "case" level, not a"comment" level.
func (Attachment)MarshalJSON¶
func (sAttachment) MarshalJSON() ([]byte,error)
typeBlobstore2Info¶
type Blobstore2Info struct {// BlobGeneration: # gdata.* are outside protos with mising documentationBlobGenerationint64 `json:"blobGeneration,omitempty,string"`// BlobId: # gdata.* are outside protos with mising documentationBlobIdstring `json:"blobId,omitempty"`// DownloadReadHandle: # gdata.* are outside protos with mising documentationDownloadReadHandlestring `json:"downloadReadHandle,omitempty"`// ReadToken: # gdata.* are outside protos with mising documentationReadTokenstring `json:"readToken,omitempty"`// UploadMetadataContainer: # gdata.* are outside protos with mising// documentationUploadMetadataContainerstring `json:"uploadMetadataContainer,omitempty"`// ForceSendFields is a list of field names (e.g. "BlobGeneration") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BlobGeneration") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Blobstore2Info: # gdata.* are outside protos with mising documentation
func (Blobstore2Info)MarshalJSON¶
func (sBlobstore2Info) MarshalJSON() ([]byte,error)
typeCase¶
type Case struct {// Classification: The issue classification applicable to this case.Classification *CaseClassification `json:"classification,omitempty"`// ContactEmail: A user-supplied email address to send case update// notifications for. This should only be used in BYOID flows, where we cannot// infer the user's email address directly from their EUCs.ContactEmailstring `json:"contactEmail,omitempty"`// CreateTime: Output only. The time this case was created.CreateTimestring `json:"createTime,omitempty"`// Creator: The user who created the case. Note: The name and email will be// obfuscated if the case was created by Google Support.Creator *Actor `json:"creator,omitempty"`// Description: A broad description of the issue.Descriptionstring `json:"description,omitempty"`// DisplayName: The short summary of the issue reported in this case.DisplayNamestring `json:"displayName,omitempty"`// Escalated: Whether the case is currently escalated.Escalatedbool `json:"escalated,omitempty"`// LanguageCode: The language the user has requested to receive support in.// This should be a BCP 47 language code (e.g., "en", "zh-CN", "zh-TW",// "ja", "ko"). If no language or an unsupported language is specified,// this field defaults to English (en). Language selection during case creation// may affect your available support options. For a list of supported languages// and their support working hours, see://https://cloud.google.com/support/docs/language-working-hoursLanguageCodestring `json:"languageCode,omitempty"`// Name: Identifier. The resource name for the case.Namestring `json:"name,omitempty"`// Priority: The priority of this case.//// Possible values:// "PRIORITY_UNSPECIFIED" - Priority is undefined or has not been set yet.// "P0" - Extreme impact on a production service. Service is hard down.// "P1" - Critical impact on a production service. Service is currently// unusable.// "P2" - Severe impact on a production service. Service is usable but// greatly impaired.// "P3" - Medium impact on a production service. Service is available, but// moderately impaired.// "P4" - General questions or minor issues. Production service is fully// available.Prioritystring `json:"priority,omitempty"`// State: Output only. The current status of the support case.//// Possible values:// "STATE_UNSPECIFIED" - Case is in an unknown state.// "NEW" - The case has been created but no one is assigned to work on it// yet.// "IN_PROGRESS_GOOGLE_SUPPORT" - The case is currently being handled by// Google support.// "ACTION_REQUIRED" - Google is waiting for a response.// "SOLUTION_PROVIDED" - A solution has been offered for the case, but it// isn't yet closed.// "CLOSED" - The case has been resolved.Statestring `json:"state,omitempty"`// SubscriberEmailAddresses: The email addresses to receive updates on this// case.SubscriberEmailAddresses []string `json:"subscriberEmailAddresses,omitempty"`// TestCase: Whether this case was created for internal API testing and should// not be acted on by the support team.TestCasebool `json:"testCase,omitempty"`// TimeZone: The timezone of the user who created the support case. It should// be in a format IANA recognizes:https://www.iana.org/time-zones. There is no// additional validation done by the API.TimeZonestring `json:"timeZone,omitempty"`// UpdateTime: Output only. The time this case was last updated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Classification") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Classification") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Case: A Case is an object that contains the details of a support case. Itcontains fields for the time it was created, its priority, itsclassification, and more. Cases can also have comments and attachments thatget added over time. A case is parented by a Google Cloud organization orproject. Organizations are identified by a number, so the name of a caseparented by an organization would look like this: ```organizations/123/cases/456 ``` Projects have two unique identifiers, an IDand 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).
func (Case)MarshalJSON¶
typeCaseClassification¶
type CaseClassification struct {// DisplayName: A display name for the classification. The display name is not// static and can change. To uniquely and consistently identify// classifications, use the `CaseClassification.id` field.DisplayNamestring `json:"displayName,omitempty"`// Id: The unique ID for a classification. Must be specified for case creation.// To retrieve valid classification IDs for case creation, use// `caseClassifications.search`. Classification IDs returned by// `caseClassifications.search` are guaranteed to be valid for at least 6// months. If a given classification is deactiveated, it will immediately stop// being returned. After 6 months, `case.create` requests using the// classification ID will fail.Idstring `json:"id,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CaseClassification: A Case Classification represents the topic that a caseis about. It's very important to use accurate classifications, becausethey're used to route your cases to specialists who can help you. Aclassification always has an ID that is its unique identifier. A valid ID isrequired when creating a case.
func (CaseClassification)MarshalJSON¶
func (sCaseClassification) MarshalJSON() ([]byte,error)
typeCaseClassificationsSearchCall¶
type CaseClassificationsSearchCall struct {// contains filtered or unexported fields}func (*CaseClassificationsSearchCall)Context¶
func (c *CaseClassificationsSearchCall) Context(ctxcontext.Context) *CaseClassificationsSearchCall
Context sets the context to be used in this call's Do method.
func (*CaseClassificationsSearchCall)Do¶
func (c *CaseClassificationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchCaseClassificationsResponse,error)
Do executes the "cloudsupport.caseClassifications.search" call.Any non-2xx status code is an error. Response headers are in either*SearchCaseClassificationsResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*CaseClassificationsSearchCall)Fields¶
func (c *CaseClassificationsSearchCall) Fields(s ...googleapi.Field) *CaseClassificationsSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CaseClassificationsSearchCall)Header¶
func (c *CaseClassificationsSearchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CaseClassificationsSearchCall)IfNoneMatch¶
func (c *CaseClassificationsSearchCall) IfNoneMatch(entityTagstring) *CaseClassificationsSearchCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CaseClassificationsSearchCall)PageSize¶
func (c *CaseClassificationsSearchCall) PageSize(pageSizeint64) *CaseClassificationsSearchCall
PageSize sets the optional parameter "pageSize": The maximum number ofclassifications fetched with each request.
func (*CaseClassificationsSearchCall)PageToken¶
func (c *CaseClassificationsSearchCall) PageToken(pageTokenstring) *CaseClassificationsSearchCall
PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. If unspecified, the first page is retrieved.
func (*CaseClassificationsSearchCall)Pages¶
func (c *CaseClassificationsSearchCall) Pages(ctxcontext.Context, f func(*SearchCaseClassificationsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*CaseClassificationsSearchCall)Query¶
func (c *CaseClassificationsSearchCall) Query(querystring) *CaseClassificationsSearchCall
Query sets the optional parameter "query": An expression used to filter caseclassifications. If it's an empty string, then no filtering happens.Otherwise, case classifications will be returned that match the filter.
typeCaseClassificationsService¶
type CaseClassificationsService struct {// contains filtered or unexported fields}funcNewCaseClassificationsService¶
func NewCaseClassificationsService(s *Service) *CaseClassificationsService
func (*CaseClassificationsService)Search¶
func (r *CaseClassificationsService) Search() *CaseClassificationsSearchCall
Search: Retrieve valid classifications to use when creating a support case.Classifications are hierarchical. Each classification is a string containingall levels of the hierarchy separated by " > ". For example, "TechnicalIssue > Compute > Compute Engine". Classification IDs returned by thisendpoint are valid for at least six months. When a classification isdeactivated, this endpoint immediately stops returning it. After six months,`case.create` requests using the classification will fail. EXAMPLES: cURL:```shell curl \ --header "Authorization: Bearer $(gcloud authprint-access-token)" \'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python importgoogleapiclient.discovery supportApiService =googleapiclient.discovery.build( serviceName="cloudsupport", version="v2",discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search(query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
typeCasesAttachmentsListCall¶
type CasesAttachmentsListCall struct {// contains filtered or unexported fields}func (*CasesAttachmentsListCall)Context¶
func (c *CasesAttachmentsListCall) Context(ctxcontext.Context) *CasesAttachmentsListCall
Context sets the context to be used in this call's Do method.
func (*CasesAttachmentsListCall)Do¶
func (c *CasesAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAttachmentsResponse,error)
Do executes the "cloudsupport.cases.attachments.list" call.Any non-2xx status code is an error. Response headers are in either*ListAttachmentsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*CasesAttachmentsListCall)Fields¶
func (c *CasesAttachmentsListCall) Fields(s ...googleapi.Field) *CasesAttachmentsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesAttachmentsListCall)Header¶
func (c *CasesAttachmentsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesAttachmentsListCall)IfNoneMatch¶
func (c *CasesAttachmentsListCall) IfNoneMatch(entityTagstring) *CasesAttachmentsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CasesAttachmentsListCall)PageSize¶
func (c *CasesAttachmentsListCall) PageSize(pageSizeint64) *CasesAttachmentsListCall
PageSize sets the optional parameter "pageSize": The maximum number ofattachments fetched with each request. If not provided, the default is 10.The maximum page size that will be returned is 100. The size of each pagecan be smaller than the requested page size and can include zero. Forexample, you could request 100 attachments on one page, receive 0, and thenon the next page, receive 90.
func (*CasesAttachmentsListCall)PageToken¶
func (c *CasesAttachmentsListCall) PageToken(pageTokenstring) *CasesAttachmentsListCall
PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. If unspecified, the first page is retrieved.
func (*CasesAttachmentsListCall)Pages¶
func (c *CasesAttachmentsListCall) Pages(ctxcontext.Context, f func(*ListAttachmentsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeCasesAttachmentsService¶
type CasesAttachmentsService struct {// contains filtered or unexported fields}funcNewCasesAttachmentsService¶
func NewCasesAttachmentsService(s *Service) *CasesAttachmentsService
func (*CasesAttachmentsService)List¶
func (r *CasesAttachmentsService) List(parentstring) *CasesAttachmentsListCall
List: List all the attachments associated with a support case. EXAMPLES:cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header"Authorization: Bearer $(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$case/attachments" ``` 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.cases() .attachments().list(parent="projects/some-project/cases/43595344") )print(request.execute()) ```
- parent: The name of the case for which attachments should be listed.
typeCasesCloseCall¶
type CasesCloseCall struct {// contains filtered or unexported fields}func (*CasesCloseCall)Context¶
func (c *CasesCloseCall) Context(ctxcontext.Context) *CasesCloseCall
Context sets the context to be used in this call's Do method.
func (*CasesCloseCall)Do¶
func (c *CasesCloseCall) Do(opts ...googleapi.CallOption) (*Case,error)
Do executes the "cloudsupport.cases.close" call.Any non-2xx status code is an error. Response headers are in either*Case.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesCloseCall)Fields¶
func (c *CasesCloseCall) Fields(s ...googleapi.Field) *CasesCloseCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesCloseCall)Header¶
func (c *CasesCloseCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCasesCommentsCreateCall¶
type CasesCommentsCreateCall struct {// contains filtered or unexported fields}func (*CasesCommentsCreateCall)Context¶
func (c *CasesCommentsCreateCall) Context(ctxcontext.Context) *CasesCommentsCreateCall
Context sets the context to be used in this call's Do method.
func (*CasesCommentsCreateCall)Do¶
func (c *CasesCommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment,error)
Do executes the "cloudsupport.cases.comments.create" call.Any non-2xx status code is an error. Response headers are in either*Comment.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesCommentsCreateCall)Fields¶
func (c *CasesCommentsCreateCall) Fields(s ...googleapi.Field) *CasesCommentsCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesCommentsCreateCall)Header¶
func (c *CasesCommentsCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCasesCommentsListCall¶
type CasesCommentsListCall struct {// contains filtered or unexported fields}func (*CasesCommentsListCall)Context¶
func (c *CasesCommentsListCall) Context(ctxcontext.Context) *CasesCommentsListCall
Context sets the context to be used in this call's Do method.
func (*CasesCommentsListCall)Do¶
func (c *CasesCommentsListCall) Do(opts ...googleapi.CallOption) (*ListCommentsResponse,error)
Do executes the "cloudsupport.cases.comments.list" call.Any non-2xx status code is an error. Response headers are in either*ListCommentsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*CasesCommentsListCall)Fields¶
func (c *CasesCommentsListCall) Fields(s ...googleapi.Field) *CasesCommentsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesCommentsListCall)Header¶
func (c *CasesCommentsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesCommentsListCall)IfNoneMatch¶
func (c *CasesCommentsListCall) IfNoneMatch(entityTagstring) *CasesCommentsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CasesCommentsListCall)PageSize¶
func (c *CasesCommentsListCall) PageSize(pageSizeint64) *CasesCommentsListCall
PageSize sets the optional parameter "pageSize": The maximum number ofcomments to fetch. Defaults to 10.
func (*CasesCommentsListCall)PageToken¶
func (c *CasesCommentsListCall) PageToken(pageTokenstring) *CasesCommentsListCall
PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. If unspecified, the first page is returned.
func (*CasesCommentsListCall)Pages¶
func (c *CasesCommentsListCall) Pages(ctxcontext.Context, f func(*ListCommentsResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeCasesCommentsService¶
type CasesCommentsService struct {// contains filtered or unexported fields}funcNewCasesCommentsService¶
func NewCasesCommentsService(s *Service) *CasesCommentsService
func (*CasesCommentsService)Create¶
func (r *CasesCommentsService) Create(parentstring, comment *Comment) *CasesCommentsCreateCall
Create: Add a new comment to a case. The comment must have the followingfields set: `body`. EXAMPLES: cURL: ```shellcase="projects/some-project/cases/43591344" curl \ --request POST \ --header"Authorization: Bearer $(gcloud auth print-access-token)" \ --header'Content-Type: application/json' \ --data '{ "body": "This is a testcomment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ```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.cases() .comments().create( parent="projects/some-project/cases/43595344", body={"body": "Thisis a test comment."}, ) ) print(request.execute()) ```
- parent: The name of the case to which the comment should be added.
func (*CasesCommentsService)List¶
func (r *CasesCommentsService) List(parentstring) *CasesCommentsListCall
List: List all the comments associated with a case. EXAMPLES: cURL: ```shellcase="projects/some-project/cases/43595344" curl \ --header "Authorization:Bearer $(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$case/comments" ``` 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.cases() .comments().list(parent="projects/some-project/cases/43595344") )print(request.execute()) ```
- parent: The name of the case for which to list comments.
typeCasesCreateCall¶
type CasesCreateCall struct {// contains filtered or unexported fields}func (*CasesCreateCall)Context¶
func (c *CasesCreateCall) Context(ctxcontext.Context) *CasesCreateCall
Context sets the context to be used in this call's Do method.
func (*CasesCreateCall)Do¶
func (c *CasesCreateCall) Do(opts ...googleapi.CallOption) (*Case,error)
Do executes the "cloudsupport.cases.create" call.Any non-2xx status code is an error. Response headers are in either*Case.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesCreateCall)Fields¶
func (c *CasesCreateCall) Fields(s ...googleapi.Field) *CasesCreateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesCreateCall)Header¶
func (c *CasesCreateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCasesEscalateCall¶
type CasesEscalateCall struct {// contains filtered or unexported fields}func (*CasesEscalateCall)Context¶
func (c *CasesEscalateCall) Context(ctxcontext.Context) *CasesEscalateCall
Context sets the context to be used in this call's Do method.
func (*CasesEscalateCall)Do¶
func (c *CasesEscalateCall) Do(opts ...googleapi.CallOption) (*Case,error)
Do executes the "cloudsupport.cases.escalate" call.Any non-2xx status code is an error. Response headers are in either*Case.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesEscalateCall)Fields¶
func (c *CasesEscalateCall) Fields(s ...googleapi.Field) *CasesEscalateCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesEscalateCall)Header¶
func (c *CasesEscalateCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeCasesGetCall¶
type CasesGetCall struct {// contains filtered or unexported fields}func (*CasesGetCall)Context¶
func (c *CasesGetCall) Context(ctxcontext.Context) *CasesGetCall
Context sets the context to be used in this call's Do method.
func (*CasesGetCall)Do¶
func (c *CasesGetCall) Do(opts ...googleapi.CallOption) (*Case,error)
Do executes the "cloudsupport.cases.get" call.Any non-2xx status code is an error. Response headers are in either*Case.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesGetCall)Fields¶
func (c *CasesGetCall) Fields(s ...googleapi.Field) *CasesGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesGetCall)Header¶
func (c *CasesGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesGetCall)IfNoneMatch¶
func (c *CasesGetCall) IfNoneMatch(entityTagstring) *CasesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeCasesListCall¶
type CasesListCall struct {// contains filtered or unexported fields}func (*CasesListCall)Context¶
func (c *CasesListCall) Context(ctxcontext.Context) *CasesListCall
Context sets the context to be used in this call's Do method.
func (*CasesListCall)Do¶
func (c *CasesListCall) Do(opts ...googleapi.CallOption) (*ListCasesResponse,error)
Do executes the "cloudsupport.cases.list" call.Any non-2xx status code is an error. Response headers are in either*ListCasesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*CasesListCall)Fields¶
func (c *CasesListCall) Fields(s ...googleapi.Field) *CasesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesListCall)Filter¶
func (c *CasesListCall) Filter(filterstring) *CasesListCall
Filter sets the optional parameter "filter": An expression used to filtercases. If it's an empty string, then no filtering happens. Otherwise, theendpoint returns the cases that match the filter. Expressions use thefollowing fields separated by `AND` and specified with `=`: - `state`: Canbe `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`.You can specify multiple values for priority using the `OR` operator. Forexample, `priority=P1 OR priority=P2`. - `creator.email`: The email addressof the case creator. EXAMPLES: - `state=CLOSED` - `state=OPEN ANDcreator.email="tester@example.com" - `state=OPEN AND (priority=P0 ORpriority=P1)`
func (*CasesListCall)Header¶
func (c *CasesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesListCall)IfNoneMatch¶
func (c *CasesListCall) IfNoneMatch(entityTagstring) *CasesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CasesListCall)PageSize¶
func (c *CasesListCall) PageSize(pageSizeint64) *CasesListCall
PageSize sets the optional parameter "pageSize": The maximum number of casesfetched with each request. Defaults to 10.
func (*CasesListCall)PageToken¶
func (c *CasesListCall) PageToken(pageTokenstring) *CasesListCall
PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. If unspecified, the first page is retrieved.
func (*CasesListCall)Pages¶
func (c *CasesListCall) Pages(ctxcontext.Context, f func(*ListCasesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
typeCasesPatchCall¶
type CasesPatchCall struct {// contains filtered or unexported fields}func (*CasesPatchCall)Context¶
func (c *CasesPatchCall) Context(ctxcontext.Context) *CasesPatchCall
Context sets the context to be used in this call's Do method.
func (*CasesPatchCall)Do¶
func (c *CasesPatchCall) Do(opts ...googleapi.CallOption) (*Case,error)
Do executes the "cloudsupport.cases.patch" call.Any non-2xx status code is an error. Response headers are in either*Case.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*CasesPatchCall)Fields¶
func (c *CasesPatchCall) Fields(s ...googleapi.Field) *CasesPatchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesPatchCall)Header¶
func (c *CasesPatchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesPatchCall)UpdateMask¶
func (c *CasesPatchCall) UpdateMask(updateMaskstring) *CasesPatchCall
UpdateMask sets the optional parameter "updateMask": A list of attributes ofthe case that should be updated. Supported values are `priority`,`display_name`, and `subscriber_email_addresses`. If no fields arespecified, all supported fields are updated. Be careful - if you do notprovide a field mask, then you might accidentally clear some fields. Forexample, if you leave the field mask empty and do not provide a value for`subscriber_email_addresses`, then `subscriber_email_addresses` is updatedto empty.
typeCasesSearchCall¶
type CasesSearchCall struct {// contains filtered or unexported fields}func (*CasesSearchCall)Context¶
func (c *CasesSearchCall) Context(ctxcontext.Context) *CasesSearchCall
Context sets the context to be used in this call's Do method.
func (*CasesSearchCall)Do¶
func (c *CasesSearchCall) Do(opts ...googleapi.CallOption) (*SearchCasesResponse,error)
Do executes the "cloudsupport.cases.search" call.Any non-2xx status code is an error. Response headers are in either*SearchCasesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*CasesSearchCall)Fields¶
func (c *CasesSearchCall) Fields(s ...googleapi.Field) *CasesSearchCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*CasesSearchCall)Header¶
func (c *CasesSearchCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*CasesSearchCall)IfNoneMatch¶
func (c *CasesSearchCall) IfNoneMatch(entityTagstring) *CasesSearchCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*CasesSearchCall)PageSize¶
func (c *CasesSearchCall) PageSize(pageSizeint64) *CasesSearchCall
PageSize sets the optional parameter "pageSize": The maximum number of casesfetched with each request. The default page size is 10.
func (*CasesSearchCall)PageToken¶
func (c *CasesSearchCall) PageToken(pageTokenstring) *CasesSearchCall
PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. If unspecified, the first page is retrieved.
func (*CasesSearchCall)Pages¶
func (c *CasesSearchCall) Pages(ctxcontext.Context, f func(*SearchCasesResponse)error)error
Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.
func (*CasesSearchCall)Query¶
func (c *CasesSearchCall) Query(querystring) *CasesSearchCall
Query sets the optional parameter "query": An expression used to filtercases. Expressions use the following fields separated by `AND` and specifiedwith `=`: - `organization`: An organization name in the form`organizations/`. - `project`: A project name in the form `projects/`. -`state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`,`P3`, or `P4`. You can specify multiple values for priority using the `OR`operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: Theemail address of the case creator. You must specify either `organization` or`project`. To search across `displayName`, `description`, and comments, usea global restriction with no keyword or operator. For example, "mysearch". To search only cases updated after a certain date, use`update_time` restricted with that particular date, time, and timezone inISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00".`update_time` only supports the greater than operator (`>`). Examples: -`organization="organizations/123456789" -`project="projects/my-project-id" - `project="projects/123456789" -`organization="organizations/123456789" AND state=CLOSED` -`project="projects/my-project-id" AND creator.email="tester@example.com" -`project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
typeCasesService¶
type CasesService struct {Attachments *CasesAttachmentsServiceComments *CasesCommentsService// contains filtered or unexported fields}funcNewCasesService¶
func NewCasesService(s *Service) *CasesService
func (*CasesService)Close¶
func (r *CasesService) Close(namestring, closecaserequest *CloseCaseRequest) *CasesCloseCall
Close: Close a case. EXAMPLES: cURL: ```shellcase="projects/some-project/cases/43595344" curl \ --request POST \ --header"Authorization: Bearer $(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```pythonimport 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.cases().close(name="projects/some-project/cases/43595344" ) print(request.execute()) ```
- name: The name of the case to close.
func (*CasesService)Create¶
func (r *CasesService) Create(parentstring, case_ *Case) *CasesCreateCall
Create: Create a new case and associate it with a parent. It must have thefollowing fields set: `display_name`, `description`, `classification`, and`priority`. If you're just testing the API and don't want to route your caseto an agent, set `testCase=true`. EXAMPLES: cURL: ```shellparent="projects/some-project" curl \ --request POST \ --header"Authorization: Bearer $(gcloud auth print-access-token)" \ --header'Content-Type: application/json' \ --data '{ "display_name": "Test casecreated by me.", "description": "a random test case, feel free to close","classification": { "id":"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00","subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ],"testCase": true, "priority": "P3" }' \"https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```pythonimport 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.cases().create(parent="projects/some-project", body={ "displayName": "A Test Case","description": "This is a test case.", "testCase": True, "priority": "P2","classification": { "id":"100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute())```
- parent: The name of the parent under which the case should be created.
func (*CasesService)Escalate¶
func (r *CasesService) Escalate(namestring, escalatecaserequest *EscalateCaseRequest) *CasesEscalateCall
Escalate: Escalate a case, starting the Google Cloud Support escalationmanagement process. This operation is only available for some supportservices. Go tohttps://cloud.google.com/support and look for 'Technicalsupport escalations' in the feature list to find out which ones let you dothat. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344"curl \ --request POST \ --header "Authorization: Bearer $(gcloud authprint-access-token)" \ --header "Content-Type: application/json" \ --data '{"escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is atest escalation." } }' \"https://cloudsupport.googleapis.com/v2/$case:escalate" ``` 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.cases().escalate(name="projects/some-project/cases/43595344", body={ "escalation": {"reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.",}, }, ) print(request.execute()) ```
- name: The name of the case to be escalated.
func (*CasesService)Get¶
func (r *CasesService) Get(namestring) *CasesGetCall
Get: Retrieve a case. EXAMPLES: cURL: ```shellcase="projects/some-project/cases/16033687" curl \ --header "Authorization:Bearer $(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python importgoogleapiclient.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.cases().get(name="projects/some-project/cases/43595344", ) print(request.execute()) ```
- name: The full name of a case to be retrieved.
func (*CasesService)List¶
func (r *CasesService) List(parentstring) *CasesListCall
List: Retrieve all cases under a parent, but not its children. For example,listing cases under an organization only returns the cases that are directlyparented by that organization. To retrieve cases under an organization andits projects, use `cases.search`. EXAMPLES: cURL: ```shellparent="projects/some-project" curl \ --header "Authorization: Bearer$(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```pythonimport 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.cases().list(parent="projects/some-project")print(request.execute()) ```
- parent: The name of a parent to list cases under.
func (*CasesService)Patch¶
func (r *CasesService) Patch(namestring, case_ *Case) *CasesPatchCall
Patch: Update a case. Only some fields can be updated. EXAMPLES: cURL:```shell case="projects/some-project/cases/43595344" curl \ --request PATCH\ --header "Authorization: Bearer $(gcloud auth print-access-token)" \--header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \"https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ```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.cases().patch(name="projects/some-project/cases/43112854", body={ "displayName": "This isNow a New Title", "priority": "P2", }, ) print(request.execute()) ```
- name: Identifier. The resource name for the case.
func (*CasesService)Search¶
func (r *CasesService) Search(parentstring) *CasesSearchCall
Search: Search for cases using a query. EXAMPLES: cURL: ```shellparent="projects/some-project" curl \ --header "Authorization: Bearer$(gcloud auth print-access-token)" \"https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` 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.cases().search(parent="projects/some-project", query="state=OPEN" )print(request.execute()) ```
- parent: The name of the parent resource to search for cases under.
typeCloseCaseRequest¶
type CloseCaseRequest struct {}CloseCaseRequest: The request message for the CloseCase endpoint.
typeComment¶
type Comment struct {// Body: The full comment body. Maximum of 12800 characters.Bodystring `json:"body,omitempty"`// CreateTime: Output only. The time when the comment was created.CreateTimestring `json:"createTime,omitempty"`// Creator: Output only. The user or Google Support agent who created the// comment.Creator *Actor `json:"creator,omitempty"`// Name: Output only. Identifier. The resource name of the comment.Namestring `json:"name,omitempty"`// PlainTextBody: Output only. DEPRECATED. DO NOT USE. A duplicate of the// `body` field. This field is only present for legacy reasons.PlainTextBodystring `json:"plainTextBody,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Body") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Body") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Comment: A comment associated with a support case. Case comments are theprimary way for Google Support to communicate with a user who has opened acase. When a user responds to Google Support, the user's responses alsoappear as comments.
func (Comment)MarshalJSON¶
typeCompositeMedia¶
type CompositeMedia struct {// BlobRef: # gdata.* are outside protos with mising documentationBlobRefstring `json:"blobRef,omitempty"`// Blobstore2Info: # gdata.* are outside protos with mising documentationBlobstore2Info *Blobstore2Info `json:"blobstore2Info,omitempty"`// CosmoBinaryReference: # gdata.* are outside protos with mising documentationCosmoBinaryReferencestring `json:"cosmoBinaryReference,omitempty"`// Crc32cHash: # gdata.* are outside protos with mising documentationCrc32cHashint64 `json:"crc32cHash,omitempty"`// Inline: # gdata.* are outside protos with mising documentationInlinestring `json:"inline,omitempty"`// Length: # gdata.* are outside protos with mising documentationLengthint64 `json:"length,omitempty,string"`// Md5Hash: # gdata.* are outside protos with mising documentationMd5Hashstring `json:"md5Hash,omitempty"`// ObjectId: # gdata.* are outside protos with mising documentationObjectId *ObjectId `json:"objectId,omitempty"`// Path: # gdata.* are outside protos with mising documentationPathstring `json:"path,omitempty"`// ReferenceType: # gdata.* are outside protos with mising documentation//// Possible values:// "PATH" - # gdata.* are outside protos with mising documentation// "BLOB_REF" - # gdata.* are outside protos with mising documentation// "INLINE" - # gdata.* are outside protos with mising documentation// "BIGSTORE_REF" - # gdata.* are outside protos with mising documentation// "COSMO_BINARY_REFERENCE" - # gdata.* are outside protos with mising// documentationReferenceTypestring `json:"referenceType,omitempty"`// Sha1Hash: # gdata.* are outside protos with mising documentationSha1Hashstring `json:"sha1Hash,omitempty"`// ForceSendFields is a list of field names (e.g. "BlobRef") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BlobRef") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CompositeMedia: # gdata.* are outside protos with mising documentation
func (CompositeMedia)MarshalJSON¶
func (sCompositeMedia) MarshalJSON() ([]byte,error)
typeContentTypeInfo¶
type ContentTypeInfo struct {// BestGuess: # gdata.* are outside protos with mising documentationBestGuessstring `json:"bestGuess,omitempty"`// FromBytes: # gdata.* are outside protos with mising documentationFromBytesstring `json:"fromBytes,omitempty"`// FromFileName: # gdata.* are outside protos with mising documentationFromFileNamestring `json:"fromFileName,omitempty"`// FromHeader: # gdata.* are outside protos with mising documentationFromHeaderstring `json:"fromHeader,omitempty"`// FromUrlPath: # gdata.* are outside protos with mising documentationFromUrlPathstring `json:"fromUrlPath,omitempty"`// ForceSendFields is a list of field names (e.g. "BestGuess") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BestGuess") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ContentTypeInfo: # gdata.* are outside protos with mising documentation
func (ContentTypeInfo)MarshalJSON¶
func (sContentTypeInfo) MarshalJSON() ([]byte,error)
typeCreateAttachmentRequest¶
type CreateAttachmentRequest struct {// Attachment: Required. The attachment to be created.Attachment *Attachment `json:"attachment,omitempty"`// ForceSendFields is a list of field names (e.g. "Attachment") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attachment") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}CreateAttachmentRequest: The request message for the CreateAttachmentendpoint.
func (CreateAttachmentRequest)MarshalJSON¶
func (sCreateAttachmentRequest) MarshalJSON() ([]byte,error)
typeDiffChecksumsResponse¶
type DiffChecksumsResponse struct {// ChecksumsLocation: # gdata.* are outside protos with mising documentationChecksumsLocation *CompositeMedia `json:"checksumsLocation,omitempty"`// ChunkSizeBytes: # gdata.* are outside protos with mising documentationChunkSizeBytesint64 `json:"chunkSizeBytes,omitempty,string"`// ObjectLocation: # gdata.* are outside protos with mising documentationObjectLocation *CompositeMedia `json:"objectLocation,omitempty"`// ObjectSizeBytes: # gdata.* are outside protos with mising documentationObjectSizeBytesint64 `json:"objectSizeBytes,omitempty,string"`// ObjectVersion: # gdata.* are outside protos with mising documentationObjectVersionstring `json:"objectVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ChecksumsLocation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChecksumsLocation") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DiffChecksumsResponse: # gdata.* are outside protos with misingdocumentation
func (DiffChecksumsResponse)MarshalJSON¶
func (sDiffChecksumsResponse) MarshalJSON() ([]byte,error)
typeDiffDownloadResponse¶
type DiffDownloadResponse struct {// ObjectLocation: # gdata.* are outside protos with mising documentationObjectLocation *CompositeMedia `json:"objectLocation,omitempty"`// ForceSendFields is a list of field names (e.g. "ObjectLocation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ObjectLocation") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DiffDownloadResponse: # gdata.* are outside protos with mising documentation
func (DiffDownloadResponse)MarshalJSON¶
func (sDiffDownloadResponse) MarshalJSON() ([]byte,error)
typeDiffUploadRequest¶
type DiffUploadRequest struct {// ChecksumsInfo: # gdata.* are outside protos with mising documentationChecksumsInfo *CompositeMedia `json:"checksumsInfo,omitempty"`// ObjectInfo: # gdata.* are outside protos with mising documentationObjectInfo *CompositeMedia `json:"objectInfo,omitempty"`// ObjectVersion: # gdata.* are outside protos with mising documentationObjectVersionstring `json:"objectVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ChecksumsInfo") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChecksumsInfo") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DiffUploadRequest: # gdata.* are outside protos with mising documentation
func (DiffUploadRequest)MarshalJSON¶
func (sDiffUploadRequest) MarshalJSON() ([]byte,error)
typeDiffUploadResponse¶
type DiffUploadResponse struct {// ObjectVersion: # gdata.* are outside protos with mising documentationObjectVersionstring `json:"objectVersion,omitempty"`// OriginalObject: # gdata.* are outside protos with mising documentationOriginalObject *CompositeMedia `json:"originalObject,omitempty"`// ForceSendFields is a list of field names (e.g. "ObjectVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ObjectVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DiffUploadResponse: # gdata.* are outside protos with mising documentation
func (DiffUploadResponse)MarshalJSON¶
func (sDiffUploadResponse) MarshalJSON() ([]byte,error)
typeDiffVersionResponse¶
type DiffVersionResponse struct {// ObjectSizeBytes: # gdata.* are outside protos with mising documentationObjectSizeBytesint64 `json:"objectSizeBytes,omitempty,string"`// ObjectVersion: # gdata.* are outside protos with mising documentationObjectVersionstring `json:"objectVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ObjectSizeBytes") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DiffVersionResponse: # gdata.* are outside protos with mising documentation
func (DiffVersionResponse)MarshalJSON¶
func (sDiffVersionResponse) MarshalJSON() ([]byte,error)
typeDownloadParameters¶
type DownloadParameters struct {// AllowGzipCompression: # gdata.* are outside protos with mising documentationAllowGzipCompressionbool `json:"allowGzipCompression,omitempty"`// IgnoreRange: # gdata.* are outside protos with mising documentationIgnoreRangebool `json:"ignoreRange,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowGzipCompression") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowGzipCompression") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DownloadParameters: # gdata.* are outside protos with mising documentation
func (DownloadParameters)MarshalJSON¶
func (sDownloadParameters) MarshalJSON() ([]byte,error)
typeEscalateCaseRequest¶
type EscalateCaseRequest struct {// Escalation: The escalation information to be sent with the escalation// request.Escalation *Escalation `json:"escalation,omitempty"`// ForceSendFields is a list of field names (e.g. "Escalation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Escalation") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}EscalateCaseRequest: The request message for the EscalateCase endpoint.
func (EscalateCaseRequest)MarshalJSON¶
func (sEscalateCaseRequest) MarshalJSON() ([]byte,error)
typeEscalation¶
type Escalation struct {// Justification: Required. A free text description to accompany the `reason`// field above. Provides additional context on why the case is being escalated.Justificationstring `json:"justification,omitempty"`// Reason: Required. The reason why the Case is being escalated.//// Possible values:// "REASON_UNSPECIFIED" - The escalation reason is in an unknown state or has// not been specified.// "RESOLUTION_TIME" - The case is taking too long to resolve.// "TECHNICAL_EXPERTISE" - The support agent does not have the expertise// required to successfully resolve the issue.// "BUSINESS_IMPACT" - The issue is having a significant business impact.Reasonstring `json:"reason,omitempty"`// ForceSendFields is a list of field names (e.g. "Justification") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Justification") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Escalation: An escalation of a support case.
func (Escalation)MarshalJSON¶
func (sEscalation) MarshalJSON() ([]byte,error)
typeListAttachmentsResponse¶
type ListAttachmentsResponse struct {// Attachments: The list of attachments associated with a case.Attachments []*Attachment `json:"attachments,omitempty"`// NextPageToken: A token to retrieve the next page of results. Set this in the// `page_token` field of subsequent `cases.attachments.list` requests. If// unspecified, there are no more results to retrieve.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Attachments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attachments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListAttachmentsResponse: The response message for the ListAttachmentsendpoint.
func (ListAttachmentsResponse)MarshalJSON¶
func (sListAttachmentsResponse) MarshalJSON() ([]byte,error)
typeListCasesResponse¶
type ListCasesResponse struct {// Cases: The list of cases associated with the parent after any filters have// been applied.Cases []*Case `json:"cases,omitempty"`// NextPageToken: A token to retrieve the next page of results. Set this in the// `page_token` field of subsequent `cases.list` requests. If unspecified,// there are no more results to retrieve.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Cases") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cases") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListCasesResponse: The response message for the ListCases endpoint.
func (ListCasesResponse)MarshalJSON¶
func (sListCasesResponse) MarshalJSON() ([]byte,error)
typeListCommentsResponse¶
type ListCommentsResponse struct {// Comments: List of the comments associated with the case.Comments []*Comment `json:"comments,omitempty"`// NextPageToken: A token to retrieve the next page of results. Set this in the// `page_token` field of subsequent `cases.comments.list` requests. If// unspecified, there are no more results to retrieve.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Comments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Comments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListCommentsResponse: The response message for the ListComments endpoint.
func (ListCommentsResponse)MarshalJSON¶
func (sListCommentsResponse) MarshalJSON() ([]byte,error)
typeMedia¶
type Media struct {// Algorithm: # gdata.* are outside protos with mising documentationAlgorithmstring `json:"algorithm,omitempty"`// BigstoreObjectRef: # gdata.* are outside protos with mising documentationBigstoreObjectRefstring `json:"bigstoreObjectRef,omitempty"`// BlobRef: # gdata.* are outside protos with mising documentationBlobRefstring `json:"blobRef,omitempty"`// Blobstore2Info: # gdata.* are outside protos with mising documentationBlobstore2Info *Blobstore2Info `json:"blobstore2Info,omitempty"`// CompositeMedia: # gdata.* are outside protos with mising documentationCompositeMedia []*CompositeMedia `json:"compositeMedia,omitempty"`// ContentType: # gdata.* are outside protos with mising documentationContentTypestring `json:"contentType,omitempty"`// ContentTypeInfo: # gdata.* are outside protos with mising documentationContentTypeInfo *ContentTypeInfo `json:"contentTypeInfo,omitempty"`// CosmoBinaryReference: # gdata.* are outside protos with mising documentationCosmoBinaryReferencestring `json:"cosmoBinaryReference,omitempty"`// Crc32cHash: # gdata.* are outside protos with mising documentationCrc32cHashint64 `json:"crc32cHash,omitempty"`// DiffChecksumsResponse: # gdata.* are outside protos with mising// documentationDiffChecksumsResponse *DiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"`// DiffDownloadResponse: # gdata.* are outside protos with mising documentationDiffDownloadResponse *DiffDownloadResponse `json:"diffDownloadResponse,omitempty"`// DiffUploadRequest: # gdata.* are outside protos with mising documentationDiffUploadRequest *DiffUploadRequest `json:"diffUploadRequest,omitempty"`// DiffUploadResponse: # gdata.* are outside protos with mising documentationDiffUploadResponse *DiffUploadResponse `json:"diffUploadResponse,omitempty"`// DiffVersionResponse: # gdata.* are outside protos with mising documentationDiffVersionResponse *DiffVersionResponse `json:"diffVersionResponse,omitempty"`// DownloadParameters: # gdata.* are outside protos with mising documentationDownloadParameters *DownloadParameters `json:"downloadParameters,omitempty"`// Filename: # gdata.* are outside protos with mising documentationFilenamestring `json:"filename,omitempty"`// Hash: # gdata.* are outside protos with mising documentationHashstring `json:"hash,omitempty"`// HashVerified: # gdata.* are outside protos with mising documentationHashVerifiedbool `json:"hashVerified,omitempty"`// Inline: # gdata.* are outside protos with mising documentationInlinestring `json:"inline,omitempty"`// IsPotentialRetry: # gdata.* are outside protos with mising documentationIsPotentialRetrybool `json:"isPotentialRetry,omitempty"`// Length: # gdata.* are outside protos with mising documentationLengthint64 `json:"length,omitempty,string"`// Md5Hash: # gdata.* are outside protos with mising documentationMd5Hashstring `json:"md5Hash,omitempty"`// MediaId: # gdata.* are outside protos with mising documentationMediaIdstring `json:"mediaId,omitempty"`// ObjectId: # gdata.* are outside protos with mising documentationObjectId *ObjectId `json:"objectId,omitempty"`// Path: # gdata.* are outside protos with mising documentationPathstring `json:"path,omitempty"`// ReferenceType: # gdata.* are outside protos with mising documentation//// Possible values:// "PATH" - # gdata.* are outside protos with mising documentation// "BLOB_REF" - # gdata.* are outside protos with mising documentation// "INLINE" - # gdata.* are outside protos with mising documentation// "GET_MEDIA" - # gdata.* are outside protos with mising documentation// "COMPOSITE_MEDIA" - # gdata.* are outside protos with mising documentation// "BIGSTORE_REF" - # gdata.* are outside protos with mising documentation// "DIFF_VERSION_RESPONSE" - # gdata.* are outside protos with mising// documentation// "DIFF_CHECKSUMS_RESPONSE" - # gdata.* are outside protos with mising// documentation// "DIFF_DOWNLOAD_RESPONSE" - # gdata.* are outside protos with mising// documentation// "DIFF_UPLOAD_REQUEST" - # gdata.* are outside protos with mising// documentation// "DIFF_UPLOAD_RESPONSE" - # gdata.* are outside protos with mising// documentation// "COSMO_BINARY_REFERENCE" - # gdata.* are outside protos with mising// documentation// "ARBITRARY_BYTES" - # gdata.* are outside protos with mising documentationReferenceTypestring `json:"referenceType,omitempty"`// Sha1Hash: # gdata.* are outside protos with mising documentationSha1Hashstring `json:"sha1Hash,omitempty"`// Sha256Hash: # gdata.* are outside protos with mising documentationSha256Hashstring `json:"sha256Hash,omitempty"`// Timestamp: # gdata.* are outside protos with mising documentationTimestampuint64 `json:"timestamp,omitempty,string"`// Token: # gdata.* are outside protos with mising documentationTokenstring `json:"token,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Algorithm") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Algorithm") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Media: # gdata.* are outside protos with mising documentation
func (Media)MarshalJSON¶
typeMediaDownloadCall¶
type MediaDownloadCall struct {// contains filtered or unexported fields}func (*MediaDownloadCall)Context¶
func (c *MediaDownloadCall) Context(ctxcontext.Context) *MediaDownloadCall
Context sets the context to be used in this call's Do and Download methods.
func (*MediaDownloadCall)Do¶
func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*Media,error)
Do executes the "cloudsupport.media.download" call.Any non-2xx status code is an error. Response headers are in either*Media.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*MediaDownloadCall)Download¶
func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response,error)
Download fetches the API endpoint's "media" value, instead of the normalAPI response value. If the returned error is nil, the Response is guaranteed tohave a 2xx status code. Callers must close the Response.Body as usual.
func (*MediaDownloadCall)Fields¶
func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*MediaDownloadCall)Header¶
func (c *MediaDownloadCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*MediaDownloadCall)IfNoneMatch¶
func (c *MediaDownloadCall) IfNoneMatch(entityTagstring) *MediaDownloadCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeMediaService¶
type MediaService struct {// contains filtered or unexported fields}funcNewMediaService¶
func NewMediaService(s *Service) *MediaService
func (*MediaService)Download¶
func (r *MediaService) Download(namestring) *MediaDownloadCall
Download: Download a file attached to a case. When this endpoint is called,no "response body" will be returned. Instead, the attachment's blob will bereturned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES:cURL: ```shellname="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()) ```
- name: The name of the file attachment to download.
func (*MediaService)Upload¶
func (r *MediaService) Upload(parentstring, createattachmentrequest *CreateAttachmentRequest) *MediaUploadCall
Upload: Create a file attachment on a case or Cloud resource. The attachmentmust have the following fields set: `filename`. EXAMPLES: cURL: ```shellecho "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 importgoogleapiclient.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 uploadusing 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()) ```
- parent: The name of the case or Cloud resource to which the attachmentshould be attached.
typeMediaUploadCall¶
type MediaUploadCall struct {// contains filtered or unexported fields}func (*MediaUploadCall)Context¶
func (c *MediaUploadCall) Context(ctxcontext.Context) *MediaUploadCall
Context sets the context to be used in this call's Do method.This context will supersede any context previously provided to theResumableMedia method.
func (*MediaUploadCall)Do¶
func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*Attachment,error)
Do executes the "cloudsupport.media.upload" call.Any non-2xx status code is an error. Response headers are in either*Attachment.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*MediaUploadCall)Fields¶
func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*MediaUploadCall)Header¶
func (c *MediaUploadCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*MediaUploadCall)Media¶
func (c *MediaUploadCall) Media(rio.Reader, options ...googleapi.MediaOption) *MediaUploadCall
Media specifies the media to upload in one or more chunks. The chunk sizemay be controlled by supplying a MediaOption generated bygoogleapi.ChunkSize. The chunk size defaults togoogleapi.DefaultUploadChunkSize.The Content-Type header used in the uploadrequest will be determined by sniffing the contents of r, unless aMediaOption generated by googleapi.ContentType is supplied.At most one of Media and ResumableMedia may be set.
func (*MediaUploadCall)ProgressUpdater¶
func (c *MediaUploadCall) ProgressUpdater(pugoogleapi.ProgressUpdater) *MediaUploadCall
ProgressUpdater provides a callback function that will be called after everychunk. It should be a low-latency function in order to not slow down theupload operation. This should only be called when using ResumableMedia (asopposed to Media).
func (*MediaUploadCall)ResumableMediadeprecated
func (c *MediaUploadCall) ResumableMedia(ctxcontext.Context, rio.ReaderAt, sizeint64, mediaTypestring) *MediaUploadCall
ResumableMedia specifies the media to upload in chunks and can be canceledwith ctx.
Deprecated: use Media instead.
At most one of Media and ResumableMedia may be set. mediaType identifies theMIME media type of the upload, such as "image/png". If mediaType is "", itwill be auto-detected. The provided ctx will supersede any contextpreviously provided to the Context method.
typeObjectId¶
type ObjectId struct {// BucketName: # gdata.* are outside protos with mising documentationBucketNamestring `json:"bucketName,omitempty"`// Generation: # gdata.* are outside protos with mising documentationGenerationint64 `json:"generation,omitempty,string"`// ObjectName: # gdata.* are outside protos with mising documentationObjectNamestring `json:"objectName,omitempty"`// ForceSendFields is a list of field names (e.g. "BucketName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BucketName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ObjectId: # gdata.* are outside protos with mising documentation
func (ObjectId)MarshalJSON¶
typeSearchCaseClassificationsResponse¶
type SearchCaseClassificationsResponse struct {// CaseClassifications: The classifications retrieved.CaseClassifications []*CaseClassification `json:"caseClassifications,omitempty"`// NextPageToken: A token to retrieve the next page of results. Set this in the// `page_token` field of subsequent `caseClassifications.list` requests. If// unspecified, there are no more results to retrieve.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CaseClassifications") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CaseClassifications") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SearchCaseClassificationsResponse: The response message forSearchCaseClassifications endpoint.
func (SearchCaseClassificationsResponse)MarshalJSON¶
func (sSearchCaseClassificationsResponse) MarshalJSON() ([]byte,error)
typeSearchCasesResponse¶
type SearchCasesResponse struct {// Cases: The list of cases associated with the parent after any filters have// been applied.Cases []*Case `json:"cases,omitempty"`// NextPageToken: A token to retrieve the next page of results. Set this in the// `page_token` field of subsequent `cases.search` requests. If unspecified,// there are no more results to retrieve.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Cases") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cases") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SearchCasesResponse: The response message for the SearchCases endpoint.
func (SearchCasesResponse)MarshalJSON¶
func (sSearchCasesResponse) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentCaseClassifications *CaseClassificationsServiceCases *CasesServiceMedia *MediaService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶
NewService creates a new Service.