Documentation ¶
Overview ¶
Package support is a generated protocol buffer package.
It is generated from these files:
google/cloud/support/v1alpha1/cloud_support.proto
It has these top-level messages:
GetSupportAccountRequest ListSupportAccountsRequest ListSupportAccountsResponse GetCaseRequest ListCasesRequest ListCasesResponse ListCommentsRequest ListCommentsResponse CreateCaseRequest UpdateCaseRequest CreateCommentRequest GetIssueTaxonomyRequest
Index ¶
- func RegisterCloudSupportServer(s *grpc.Server, srv CloudSupportServer)
- type CloudSupportClient
- type CloudSupportServer
- type CreateCaseRequest
- type CreateCommentRequest
- func (*CreateCommentRequest) Descriptor() ([]byte, []int)
- func (m *CreateCommentRequest) GetComment() *google_cloud_support_common.Comment
- func (m *CreateCommentRequest) GetName() string
- func (*CreateCommentRequest) ProtoMessage()
- func (m *CreateCommentRequest) Reset()
- func (m *CreateCommentRequest) String() string
- type GetCaseRequest
- type GetIssueTaxonomyRequest
- type GetSupportAccountRequest
- type ListCasesRequest
- func (*ListCasesRequest) Descriptor() ([]byte, []int)
- func (m *ListCasesRequest) GetFilter() string
- func (m *ListCasesRequest) GetName() string
- func (m *ListCasesRequest) GetPageSize() int64
- func (m *ListCasesRequest) GetPageToken() string
- func (*ListCasesRequest) ProtoMessage()
- func (m *ListCasesRequest) Reset()
- func (m *ListCasesRequest) String() string
- type ListCasesResponse
- func (*ListCasesResponse) Descriptor() ([]byte, []int)
- func (m *ListCasesResponse) GetCases() []*google_cloud_support_common.Case
- func (m *ListCasesResponse) GetNextPageToken() string
- func (*ListCasesResponse) ProtoMessage()
- func (m *ListCasesResponse) Reset()
- func (m *ListCasesResponse) String() string
- type ListCommentsRequest
- type ListCommentsResponse
- type ListSupportAccountsRequest
- func (*ListSupportAccountsRequest) Descriptor() ([]byte, []int)
- func (m *ListSupportAccountsRequest) GetFilter() string
- func (m *ListSupportAccountsRequest) GetPageSize() int64
- func (m *ListSupportAccountsRequest) GetPageToken() string
- func (*ListSupportAccountsRequest) ProtoMessage()
- func (m *ListSupportAccountsRequest) Reset()
- func (m *ListSupportAccountsRequest) String() string
- type ListSupportAccountsResponse
- func (*ListSupportAccountsResponse) Descriptor() ([]byte, []int)
- func (m *ListSupportAccountsResponse) GetAccounts() []*google_cloud_support_common.SupportAccount
- func (m *ListSupportAccountsResponse) GetNextPageToken() string
- func (*ListSupportAccountsResponse) ProtoMessage()
- func (m *ListSupportAccountsResponse) Reset()
- func (m *ListSupportAccountsResponse) String() string
- type UpdateCaseRequest
- func (*UpdateCaseRequest) Descriptor() ([]byte, []int)
- func (m *UpdateCaseRequest) GetCase() *google_cloud_support_common.Case
- func (m *UpdateCaseRequest) GetUpdateMask() *google_protobuf3.FieldMask
- func (*UpdateCaseRequest) ProtoMessage()
- func (m *UpdateCaseRequest) Reset()
- func (m *UpdateCaseRequest) String() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterCloudSupportServer ¶
func RegisterCloudSupportServer(s *grpc.Server, srv CloudSupportServer)
Types ¶
type CloudSupportClient ¶
type CloudSupportClient interface { // Retrieves the support account details given an account identifier. // The authenticated user calling this method must be the account owner. GetSupportAccount(ctx context.Context, in *GetSupportAccountRequest, opts ...grpc.CallOption) (*google_cloud_support_common.SupportAccount, error) // Retrieves the list of accounts the current authenticated user has access // to. ListSupportAccounts(ctx context.Context, in *ListSupportAccountsRequest, opts ...grpc.CallOption) (*ListSupportAccountsResponse, error) // Retrieves the details for a support case. The current authenticated user // calling this method must have permissions to view this case. GetCase(ctx context.Context, in *GetCaseRequest, opts ...grpc.CallOption) (*google_cloud_support_common.Case, error) // Retrieves the list of support cases associated with an account. The current // authenticated user must have the permission to list and view these cases. ListCases(ctx context.Context, in *ListCasesRequest, opts ...grpc.CallOption) (*ListCasesResponse, error) // Lists all comments from a case. ListComments(ctx context.Context, in *ListCommentsRequest, opts ...grpc.CallOption) (*ListCommentsResponse, error) // Creates a case and associates it with a // [SupportAccount][google.cloud.support.v1alpha2.SupportAcccount]. The // authenticated user attempting this action must have permissions to create a // `Case` under that [SupportAccount]. CreateCase(ctx context.Context, in *CreateCaseRequest, opts ...grpc.CallOption) (*google_cloud_support_common.Case, error) // Updates a support case. Only a small set of details (priority, subject and // cc_address) can be update after a case is created. UpdateCase(ctx context.Context, in *UpdateCaseRequest, opts ...grpc.CallOption) (*google_cloud_support_common.Case, error) // Adds a new comment to a case. CreateComment(ctx context.Context, in *CreateCommentRequest, opts ...grpc.CallOption) (*google_cloud_support_common.Comment, error) // Retrieves the taxonomy of product categories and components to be used // while creating a support case. GetIssueTaxonomy(ctx context.Context, in *GetIssueTaxonomyRequest, opts ...grpc.CallOption) (*google_cloud_support_common.IssueTaxonomy, error) }
func NewCloudSupportClient ¶
func NewCloudSupportClient(cc *grpc.ClientConn) CloudSupportClient
type CloudSupportServer ¶
type CloudSupportServer interface { // Retrieves the support account details given an account identifier. // The authenticated user calling this method must be the account owner. GetSupportAccount(context.Context, *GetSupportAccountRequest) (*google_cloud_support_common.SupportAccount, error) // Retrieves the list of accounts the current authenticated user has access // to. ListSupportAccounts(context.Context, *ListSupportAccountsRequest) (*ListSupportAccountsResponse, error) // Retrieves the details for a support case. The current authenticated user // calling this method must have permissions to view this case. GetCase(context.Context, *GetCaseRequest) (*google_cloud_support_common.Case, error) // Retrieves the list of support cases associated with an account. The current // authenticated user must have the permission to list and view these cases. ListCases(context.Context, *ListCasesRequest) (*ListCasesResponse, error) // Lists all comments from a case. ListComments(context.Context, *ListCommentsRequest) (*ListCommentsResponse, error) // Creates a case and associates it with a // [SupportAccount][google.cloud.support.v1alpha2.SupportAcccount]. The // authenticated user attempting this action must have permissions to create a // `Case` under that [SupportAccount]. CreateCase(context.Context, *CreateCaseRequest) (*google_cloud_support_common.Case, error) // Updates a support case. Only a small set of details (priority, subject and // cc_address) can be update after a case is created. UpdateCase(context.Context, *UpdateCaseRequest) (*google_cloud_support_common.Case, error) // Adds a new comment to a case. CreateComment(context.Context, *CreateCommentRequest) (*google_cloud_support_common.Comment, error) // Retrieves the taxonomy of product categories and components to be used // while creating a support case. GetIssueTaxonomy(context.Context, *GetIssueTaxonomyRequest) (*google_cloud_support_common.IssueTaxonomy, error) }
type CreateCaseRequest ¶
type CreateCaseRequest struct { // The resource name for `SupportAccount` under which this case is created. Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"` // The case resource to create. Case *google_cloud_support_common.Case `protobuf:"bytes,2,opt,name=case" json:"case,omitempty"` }
The request message for `CreateCase` method.
func (*CreateCaseRequest) Descriptor ¶
func (*CreateCaseRequest) Descriptor() ([]byte, []int)
func (*CreateCaseRequest) GetCase ¶
func (m *CreateCaseRequest) GetCase() *google_cloud_support_common.Case
func (*CreateCaseRequest) GetParent ¶
func (m *CreateCaseRequest) GetParent() string
func (*CreateCaseRequest) ProtoMessage ¶
func (*CreateCaseRequest) ProtoMessage()
func (*CreateCaseRequest) Reset ¶
func (m *CreateCaseRequest) Reset()
func (*CreateCaseRequest) String ¶
func (m *CreateCaseRequest) String() string
type CreateCommentRequest ¶
type CreateCommentRequest struct { // The resource name of case to which this comment should be added. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The `Comment` to be added to this case. Comment *google_cloud_support_common.Comment `protobuf:"bytes,2,opt,name=comment" json:"comment,omitempty"` }
The request message for `CreateComment` method.
func (*CreateCommentRequest) Descriptor ¶
func (*CreateCommentRequest) Descriptor() ([]byte, []int)
func (*CreateCommentRequest) GetComment ¶
func (m *CreateCommentRequest) GetComment() *google_cloud_support_common.Comment
func (*CreateCommentRequest) GetName ¶
func (m *CreateCommentRequest) GetName() string
func (*CreateCommentRequest) ProtoMessage ¶
func (*CreateCommentRequest) ProtoMessage()
func (*CreateCommentRequest) Reset ¶
func (m *CreateCommentRequest) Reset()
func (*CreateCommentRequest) String ¶
func (m *CreateCommentRequest) String() string
type GetCaseRequest ¶
type GetCaseRequest struct { // Name of case resource requested. // For example: "supportAccounts/accountA/cases/123" Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` }
The request message for `GetCase` method.
func (*GetCaseRequest) Descriptor ¶
func (*GetCaseRequest) Descriptor() ([]byte, []int)
func (*GetCaseRequest) GetName ¶
func (m *GetCaseRequest) GetName() string
func (*GetCaseRequest) ProtoMessage ¶
func (*GetCaseRequest) ProtoMessage()
func (*GetCaseRequest) Reset ¶
func (m *GetCaseRequest) Reset()
func (*GetCaseRequest) String ¶
func (m *GetCaseRequest) String() string
type GetIssueTaxonomyRequest ¶
type GetIssueTaxonomyRequest struct { }
The request message for `GetIssueTaxonomy` method.
func (*GetIssueTaxonomyRequest) Descriptor ¶
func (*GetIssueTaxonomyRequest) Descriptor() ([]byte, []int)
func (*GetIssueTaxonomyRequest) ProtoMessage ¶
func (*GetIssueTaxonomyRequest) ProtoMessage()
func (*GetIssueTaxonomyRequest) Reset ¶
func (m *GetIssueTaxonomyRequest) Reset()
func (*GetIssueTaxonomyRequest) String ¶
func (m *GetIssueTaxonomyRequest) String() string
type GetSupportAccountRequest ¶
type GetSupportAccountRequest struct { // The resource name of the support accounts. For example: // `supportAccounts/accountA`. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` }
The request message for `GetSupportAccount`.
func (*GetSupportAccountRequest) Descriptor ¶
func (*GetSupportAccountRequest) Descriptor() ([]byte, []int)
func (*GetSupportAccountRequest) GetName ¶
func (m *GetSupportAccountRequest) GetName() string
func (*GetSupportAccountRequest) ProtoMessage ¶
func (*GetSupportAccountRequest) ProtoMessage()
func (*GetSupportAccountRequest) Reset ¶
func (m *GetSupportAccountRequest) Reset()
func (*GetSupportAccountRequest) String ¶
func (m *GetSupportAccountRequest) String() string
type ListCasesRequest ¶
type ListCasesRequest struct { // Name of the account resource for which cases are requested. For example: // "supportAccounts/accountA" Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The filter applied to the search results. Currently it only accepts "OPEN" // or "CLOSED" strings, filtering out cases that are open or resolved. Filter string `protobuf:"bytes,2,opt,name=filter" json:"filter,omitempty"` // Maximum number of cases fetched with each request. PageSize int64 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"` // A token identifying the page of results to return. If unspecified, the // first page is retrieved. PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"` }
The request message for `ListCase` method.
func (*ListCasesRequest) Descriptor ¶
func (*ListCasesRequest) Descriptor() ([]byte, []int)
func (*ListCasesRequest) GetFilter ¶
func (m *ListCasesRequest) GetFilter() string
func (*ListCasesRequest) GetName ¶
func (m *ListCasesRequest) GetName() string
func (*ListCasesRequest) GetPageSize ¶
func (m *ListCasesRequest) GetPageSize() int64
func (*ListCasesRequest) GetPageToken ¶
func (m *ListCasesRequest) GetPageToken() string
func (*ListCasesRequest) ProtoMessage ¶
func (*ListCasesRequest) ProtoMessage()
func (*ListCasesRequest) Reset ¶
func (m *ListCasesRequest) Reset()
func (*ListCasesRequest) String ¶
func (m *ListCasesRequest) String() string
type ListCasesResponse ¶
type ListCasesResponse struct { // A list of cases. Cases []*google_cloud_support_common.Case `protobuf:"bytes,1,rep,name=cases" json:"cases,omitempty"` // A token to retrieve the next page of results. This should be passed on in // `page_token` field of `ListCaseRequest` for next request. If unspecified, // there are no more results to retrieve. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"` }
The response message for `ListCase` method.
func (*ListCasesResponse) Descriptor ¶
func (*ListCasesResponse) Descriptor() ([]byte, []int)
func (*ListCasesResponse) GetCases ¶
func (m *ListCasesResponse) GetCases() []*google_cloud_support_common.Case
func (*ListCasesResponse) GetNextPageToken ¶
func (m *ListCasesResponse) GetNextPageToken() string
func (*ListCasesResponse) ProtoMessage ¶
func (*ListCasesResponse) ProtoMessage()
func (*ListCasesResponse) Reset ¶
func (m *ListCasesResponse) Reset()
func (*ListCasesResponse) String ¶
func (m *ListCasesResponse) String() string
type ListCommentsRequest ¶
type ListCommentsRequest struct { // The resource name of case for which comments should be listed. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` }
The request message for `ListComments` method.
func (*ListCommentsRequest) Descriptor ¶
func (*ListCommentsRequest) Descriptor() ([]byte, []int)
func (*ListCommentsRequest) GetName ¶
func (m *ListCommentsRequest) GetName() string
func (*ListCommentsRequest) ProtoMessage ¶
func (*ListCommentsRequest) ProtoMessage()
func (*ListCommentsRequest) Reset ¶
func (m *ListCommentsRequest) Reset()
func (*ListCommentsRequest) String ¶
func (m *ListCommentsRequest) String() string
type ListCommentsResponse ¶
type ListCommentsResponse struct { // A list of comments. Comments []*google_cloud_support_common.Comment `protobuf:"bytes,1,rep,name=comments" json:"comments,omitempty"` }
The response message for `ListComments` method.
func (*ListCommentsResponse) Descriptor ¶
func (*ListCommentsResponse) Descriptor() ([]byte, []int)
func (*ListCommentsResponse) GetComments ¶
func (m *ListCommentsResponse) GetComments() []*google_cloud_support_common.Comment
func (*ListCommentsResponse) ProtoMessage ¶
func (*ListCommentsResponse) ProtoMessage()
func (*ListCommentsResponse) Reset ¶
func (m *ListCommentsResponse) Reset()
func (*ListCommentsResponse) String ¶
func (m *ListCommentsResponse) String() string
type ListSupportAccountsRequest ¶
type ListSupportAccountsRequest struct { // The filter applied to search results. It only supports filtering a support // account list by a cloud_resource. For example, to filter results by support // accounts associated with an Organization, its value should be: // "cloud_resource:organizations/<organization_id>" Filter string `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"` // Maximum number of accounts fetched with each request. PageSize int64 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"` // A token identifying the page of results to return. If unspecified, the // first page is retrieved. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"` }
The request message for `ListSupportAccount`.
func (*ListSupportAccountsRequest) Descriptor ¶
func (*ListSupportAccountsRequest) Descriptor() ([]byte, []int)
func (*ListSupportAccountsRequest) GetFilter ¶
func (m *ListSupportAccountsRequest) GetFilter() string
func (*ListSupportAccountsRequest) GetPageSize ¶
func (m *ListSupportAccountsRequest) GetPageSize() int64
func (*ListSupportAccountsRequest) GetPageToken ¶
func (m *ListSupportAccountsRequest) GetPageToken() string
func (*ListSupportAccountsRequest) ProtoMessage ¶
func (*ListSupportAccountsRequest) ProtoMessage()
func (*ListSupportAccountsRequest) Reset ¶
func (m *ListSupportAccountsRequest) Reset()
func (*ListSupportAccountsRequest) String ¶
func (m *ListSupportAccountsRequest) String() string
type ListSupportAccountsResponse ¶
type ListSupportAccountsResponse struct { // A list of support accounts. Accounts []*google_cloud_support_common.SupportAccount `protobuf:"bytes,1,rep,name=accounts" json:"accounts,omitempty"` // A token to retrieve the next page of results. This should be passed on in // `page_token` field of `ListSupportAccountRequest` for next request. If // unspecified, there are no more results to retrieve. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"` }
The response message for `ListSupportAccount`.
func (*ListSupportAccountsResponse) Descriptor ¶
func (*ListSupportAccountsResponse) Descriptor() ([]byte, []int)
func (*ListSupportAccountsResponse) GetAccounts ¶
func (m *ListSupportAccountsResponse) GetAccounts() []*google_cloud_support_common.SupportAccount
func (*ListSupportAccountsResponse) GetNextPageToken ¶
func (m *ListSupportAccountsResponse) GetNextPageToken() string
func (*ListSupportAccountsResponse) ProtoMessage ¶
func (*ListSupportAccountsResponse) ProtoMessage()
func (*ListSupportAccountsResponse) Reset ¶
func (m *ListSupportAccountsResponse) Reset()
func (*ListSupportAccountsResponse) String ¶
func (m *ListSupportAccountsResponse) String() string
type UpdateCaseRequest ¶
type UpdateCaseRequest struct { // The case resource to update. Case *google_cloud_support_common.Case `protobuf:"bytes,1,opt,name=case" json:"case,omitempty"` // A field that represents attributes of a Case object that should be updated // as part of this request. UpdateMask *google_protobuf3.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"` }
The request message for `UpdateCase` method.
func (*UpdateCaseRequest) Descriptor ¶
func (*UpdateCaseRequest) Descriptor() ([]byte, []int)
func (*UpdateCaseRequest) GetCase ¶
func (m *UpdateCaseRequest) GetCase() *google_cloud_support_common.Case
func (*UpdateCaseRequest) GetUpdateMask ¶
func (m *UpdateCaseRequest) GetUpdateMask() *google_protobuf3.FieldMask
func (*UpdateCaseRequest) ProtoMessage ¶
func (*UpdateCaseRequest) ProtoMessage()
func (*UpdateCaseRequest) Reset ¶
func (m *UpdateCaseRequest) Reset()
func (*UpdateCaseRequest) String ¶
func (m *UpdateCaseRequest) String() string