Documentation ¶
Overview ¶
Package serviceregistry provides access to the Google Cloud Service Registry API.
See https://cloud.google.com/service-registry/
Usage example:
import "google.golang.org/api/serviceregistry/v0.alpha" ... serviceregistryService, err := serviceregistry.New(oauthHttpClient)
Index ¶
- Constants
- type Endpoint
- type EndpointEndpointVisibility
- type EndpointsDeleteCall
- type EndpointsGetCall
- func (c *EndpointsGetCall) Context(ctx context.Context) *EndpointsGetCall
- func (c *EndpointsGetCall) Do(opts ...googleapi.CallOption) (*Endpoint, error)
- func (c *EndpointsGetCall) Fields(s ...googleapi.Field) *EndpointsGetCall
- func (c *EndpointsGetCall) IfNoneMatch(entityTag string) *EndpointsGetCall
- type EndpointsInsertCall
- type EndpointsListCall
- func (c *EndpointsListCall) Context(ctx context.Context) *EndpointsListCall
- func (c *EndpointsListCall) Do(opts ...googleapi.CallOption) (*EndpointsListResponse, error)
- func (c *EndpointsListCall) Fields(s ...googleapi.Field) *EndpointsListCall
- func (c *EndpointsListCall) Filter(filter string) *EndpointsListCall
- func (c *EndpointsListCall) IfNoneMatch(entityTag string) *EndpointsListCall
- func (c *EndpointsListCall) MaxResults(maxResults int64) *EndpointsListCall
- func (c *EndpointsListCall) OrderBy(orderBy string) *EndpointsListCall
- func (c *EndpointsListCall) PageToken(pageToken string) *EndpointsListCall
- func (c *EndpointsListCall) Pages(ctx context.Context, f func(*EndpointsListResponse) error) error
- type EndpointsListResponse
- type EndpointsPatchCall
- type EndpointsService
- func (r *EndpointsService) Delete(project string, endpoint string) *EndpointsDeleteCall
- func (r *EndpointsService) Get(project string, endpoint string) *EndpointsGetCall
- func (r *EndpointsService) Insert(project string, endpoint *Endpoint) *EndpointsInsertCall
- func (r *EndpointsService) List(project string) *EndpointsListCall
- func (r *EndpointsService) Patch(project string, endpoint string, endpoint2 *Endpoint) *EndpointsPatchCall
- func (r *EndpointsService) Update(project string, endpoint string, endpoint2 *Endpoint) *EndpointsUpdateCall
- type EndpointsUpdateCall
- type Operation
- type OperationError
- type OperationErrorErrors
- type OperationWarnings
- type OperationWarningsData
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*OperationsListResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall
- func (c *OperationsListCall) OrderBy(orderBy string) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*OperationsListResponse) error) error
- type OperationsListResponse
- type OperationsService
- type Service
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View your data across Google Cloud Platform services CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only" // View and manage your Google Cloud Platform management resources and // deployment status information NdevCloudmanScope = "https://www.googleapis.com/auth/ndev.cloudman" // View your Google Cloud Platform management resources and deployment // status information NdevCloudmanReadonlyScope = "https://www.googleapis.com/auth/ndev.cloudman.readonly" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Endpoint ¶
type Endpoint struct { // Address: A user-provided address of the service represented by this // endpoint. This can be an IPv4 or IPv6 address, or a hostname. Address string `json:"address,omitempty"` // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` // Description: An optional user-provided description of the endpoint. Description string `json:"description,omitempty"` // Fingerprint: Supply the fingerprint value for update requests. The // fingerprint value is generated by the server and ensures optimistic // concurrency (so that only one update can be performed at a time). The // fingerprint changes after each update. Fingerprint string `json:"fingerprint,omitempty"` // Id: [Output Only] Unique identifier for the resource; defined by the // server. Id uint64 `json:"id,omitempty,string"` // Name: A user-provided name of the endpoint, which must be unique // within the project. The name must comply with RFC1035. Specifically, // the name must be 1-63 characters long and match the regular // expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character // must be a lowercase letter, and all following characters must be a // dash, lowercase letter, or digit, except the last character, which // cannot be a dash. Name string `json:"name,omitempty"` // Port: An optional user-provided port of the service represented by // this endpoint. Port int64 `json:"port,omitempty"` // SelfLink: [Output Only] Self link for the endpoint. SelfLink string `json:"selfLink,omitempty"` // State: [Output Only] The current state of the endpoint, as determined // by the system. State string `json:"state,omitempty"` // Visibility: The DNS Integration configuration for this endpoint. This // must be a list of fully-qualified URLs to Compute Engine networks. Visibility *EndpointEndpointVisibility `json:"visibility,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Address") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Address") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Endpoint: Next available tag: 13
func (*Endpoint) MarshalJSON ¶
type EndpointEndpointVisibility ¶
type EndpointEndpointVisibility struct { // InternalDnsName: [Output Only] Fully qualified domain name for the // endpoint; used when addressing the endpoint from within Compute // Networks specified in the networks field. InternalDnsName string `json:"internalDnsName,omitempty"` // Networks: Google Compute Engine networks for which the name of this // endpoint should be resolvable through DNS. Networks []string `json:"networks,omitempty"` // ForceSendFields is a list of field names (e.g. "InternalDnsName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InternalDnsName") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*EndpointEndpointVisibility) MarshalJSON ¶
func (s *EndpointEndpointVisibility) MarshalJSON() ([]byte, error)
type EndpointsDeleteCall ¶
type EndpointsDeleteCall struct {
// contains filtered or unexported fields
}
func (*EndpointsDeleteCall) Context ¶
func (c *EndpointsDeleteCall) Context(ctx context.Context) *EndpointsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsDeleteCall) Do ¶
func (c *EndpointsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "serviceregistry.endpoints.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsDeleteCall) Fields ¶
func (c *EndpointsDeleteCall) Fields(s ...googleapi.Field) *EndpointsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type EndpointsGetCall ¶
type EndpointsGetCall struct {
// contains filtered or unexported fields
}
func (*EndpointsGetCall) Context ¶
func (c *EndpointsGetCall) Context(ctx context.Context) *EndpointsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsGetCall) Do ¶
func (c *EndpointsGetCall) Do(opts ...googleapi.CallOption) (*Endpoint, error)
Do executes the "serviceregistry.endpoints.get" call. Exactly one of *Endpoint or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Endpoint.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsGetCall) Fields ¶
func (c *EndpointsGetCall) Fields(s ...googleapi.Field) *EndpointsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*EndpointsGetCall) IfNoneMatch ¶
func (c *EndpointsGetCall) IfNoneMatch(entityTag string) *EndpointsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type EndpointsInsertCall ¶
type EndpointsInsertCall struct {
// contains filtered or unexported fields
}
func (*EndpointsInsertCall) Context ¶
func (c *EndpointsInsertCall) Context(ctx context.Context) *EndpointsInsertCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsInsertCall) Do ¶
func (c *EndpointsInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "serviceregistry.endpoints.insert" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsInsertCall) Fields ¶
func (c *EndpointsInsertCall) Fields(s ...googleapi.Field) *EndpointsInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type EndpointsListCall ¶
type EndpointsListCall struct {
// contains filtered or unexported fields
}
func (*EndpointsListCall) Context ¶
func (c *EndpointsListCall) Context(ctx context.Context) *EndpointsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsListCall) Do ¶
func (c *EndpointsListCall) Do(opts ...googleapi.CallOption) (*EndpointsListResponse, error)
Do executes the "serviceregistry.endpoints.list" call. Exactly one of *EndpointsListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *EndpointsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsListCall) Fields ¶
func (c *EndpointsListCall) Fields(s ...googleapi.Field) *EndpointsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*EndpointsListCall) Filter ¶
func (c *EndpointsListCall) Filter(filter string) *EndpointsListCall
Filter sets the optional parameter "filter": Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
func (*EndpointsListCall) IfNoneMatch ¶
func (c *EndpointsListCall) IfNoneMatch(entityTag string) *EndpointsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*EndpointsListCall) MaxResults ¶
func (c *EndpointsListCall) MaxResults(maxResults int64) *EndpointsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
func (*EndpointsListCall) OrderBy ¶
func (c *EndpointsListCall) OrderBy(orderBy string) *EndpointsListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Currently, only sorting by name or creationTimestamp desc is supported.
func (*EndpointsListCall) PageToken ¶
func (c *EndpointsListCall) PageToken(pageToken string) *EndpointsListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
func (*EndpointsListCall) Pages ¶
func (c *EndpointsListCall) Pages(ctx context.Context, f func(*EndpointsListResponse) 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.
type EndpointsListResponse ¶
type EndpointsListResponse struct { // Endpoints: The endpoints contained in this response. Endpoints []*Endpoint `json:"endpoints,omitempty"` // NextPageToken: [Output Only] This token allows you to get the next // page of results for list requests. If the number of results is larger // than maxResults, use the nextPageToken as a value for the query // parameter pageToken in the next list request. Subsequent list // requests will have their own nextPageToken to continue paging through // the results. NextPageToken string `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. "Endpoints") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Endpoints") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EndpointsListResponse: A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 6
func (*EndpointsListResponse) MarshalJSON ¶
func (s *EndpointsListResponse) MarshalJSON() ([]byte, error)
type EndpointsPatchCall ¶
type EndpointsPatchCall struct {
// contains filtered or unexported fields
}
func (*EndpointsPatchCall) Context ¶
func (c *EndpointsPatchCall) Context(ctx context.Context) *EndpointsPatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsPatchCall) Do ¶
func (c *EndpointsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "serviceregistry.endpoints.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsPatchCall) Fields ¶
func (c *EndpointsPatchCall) Fields(s ...googleapi.Field) *EndpointsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type EndpointsService ¶
type EndpointsService struct {
// contains filtered or unexported fields
}
func NewEndpointsService ¶
func NewEndpointsService(s *Service) *EndpointsService
func (*EndpointsService) Delete ¶
func (r *EndpointsService) Delete(project string, endpoint string) *EndpointsDeleteCall
Delete: Deletes an endpoint.
func (*EndpointsService) Get ¶
func (r *EndpointsService) Get(project string, endpoint string) *EndpointsGetCall
Get: Gets an endpoint.
func (*EndpointsService) Insert ¶
func (r *EndpointsService) Insert(project string, endpoint *Endpoint) *EndpointsInsertCall
Insert: Creates an endpoint.
func (*EndpointsService) List ¶
func (r *EndpointsService) List(project string) *EndpointsListCall
List: Lists endpoints for a project.
func (*EndpointsService) Patch ¶
func (r *EndpointsService) Patch(project string, endpoint string, endpoint2 *Endpoint) *EndpointsPatchCall
Patch: Updates an endpoint. This method supports patch semantics.
func (*EndpointsService) Update ¶
func (r *EndpointsService) Update(project string, endpoint string, endpoint2 *Endpoint) *EndpointsUpdateCall
Update: Updates an endpoint.
type EndpointsUpdateCall ¶
type EndpointsUpdateCall struct {
// contains filtered or unexported fields
}
func (*EndpointsUpdateCall) Context ¶
func (c *EndpointsUpdateCall) Context(ctx context.Context) *EndpointsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EndpointsUpdateCall) Do ¶
func (c *EndpointsUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "serviceregistry.endpoints.update" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*EndpointsUpdateCall) Fields ¶
func (c *EndpointsUpdateCall) Fields(s ...googleapi.Field) *EndpointsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type Operation ¶
type Operation struct { // ClientOperationId: [Output Only] Reserved for future use. ClientOperationId string `json:"clientOperationId,omitempty"` // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text // format. CreationTimestamp string `json:"creationTimestamp,omitempty"` // Description: [Output Only] A textual description of the operation, // which is set when the operation is created. Description string `json:"description,omitempty"` // EndTime: [Output Only] The time that this operation was completed. // This value is in RFC3339 text format. EndTime string `json:"endTime,omitempty"` // Error: [Output Only] If errors are generated during processing of the // operation, this field will be populated. Error *OperationError `json:"error,omitempty"` // HttpErrorMessage: [Output Only] If the operation fails, this field // contains the HTTP error message that was returned, such as NOT FOUND. HttpErrorMessage string `json:"httpErrorMessage,omitempty"` // HttpErrorStatusCode: [Output Only] If the operation fails, this field // contains the HTTP error status code that was returned. For example, a // 404 means the resource was not found. HttpErrorStatusCode int64 `json:"httpErrorStatusCode,omitempty"` // Id: [Output Only] The unique identifier for the resource. This // identifier is defined by the server. Id uint64 `json:"id,omitempty,string"` // InsertTime: [Output Only] The time that this operation was requested. // This value is in RFC3339 text format. InsertTime string `json:"insertTime,omitempty"` // Kind: [Output Only] Type of the resource. Always compute#operation // for Operation resources. Kind string `json:"kind,omitempty"` // Name: [Output Only] Name of the resource. Name string `json:"name,omitempty"` // OperationType: [Output Only] The type of operation, such as insert, // update, or delete, and so on. OperationType string `json:"operationType,omitempty"` // Progress: [Output Only] An optional progress indicator that ranges // from 0 to 100. There is no requirement that this be linear or support // any granularity of operations. This should not be used to guess when // the operation will be complete. This number should monotonically // increase as the operation progresses. Progress int64 `json:"progress,omitempty"` // Region: [Output Only] The URL of the region where the operation // resides. Only available when performing regional operations. Region string `json:"region,omitempty"` // SelfLink: [Output Only] Server-defined URL for the resource. SelfLink string `json:"selfLink,omitempty"` // StartTime: [Output Only] The time that this operation was started by // the server. This value is in RFC3339 text format. StartTime string `json:"startTime,omitempty"` // Status: [Output Only] The status of the operation, which can be one // of the following: PENDING, RUNNING, or DONE. Status string `json:"status,omitempty"` // StatusMessage: [Output Only] An optional textual description of the // current status of the operation. StatusMessage string `json:"statusMessage,omitempty"` // TargetId: [Output Only] The unique target ID, which identifies a // specific incarnation of the target resource. TargetId uint64 `json:"targetId,omitempty,string"` // TargetLink: [Output Only] The URL of the resource that the operation // modifies. TargetLink string `json:"targetLink,omitempty"` // User: [Output Only] User who requested the operation, for example: // user@example.com. User string `json:"user,omitempty"` // Warnings: [Output Only] If warning messages are generated during // processing of the operation, this field will be populated. Warnings []*OperationWarnings `json:"warnings,omitempty"` // Zone: [Output Only] The URL of the zone where the operation resides. // Only available when performing per-zone operations. Zone string `json:"zone,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ClientOperationId") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClientOperationId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Operation: An Operation resource, used to manage asynchronous API requests.
func (*Operation) MarshalJSON ¶
type OperationError ¶
type OperationError struct { // Errors: [Output Only] The array of errors encountered while // processing this operation. Errors []*OperationErrorErrors `json:"errors,omitempty"` // ForceSendFields is a list of field names (e.g. "Errors") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Errors") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OperationError: [Output Only] If errors are generated during processing of the operation, this field will be populated.
func (*OperationError) MarshalJSON ¶
func (s *OperationError) MarshalJSON() ([]byte, error)
type OperationErrorErrors ¶
type OperationErrorErrors struct { // Code: [Output Only] The error type identifier for this error. Code string `json:"code,omitempty"` // Location: [Output Only] Indicates the field in the request that // caused the error. This property is optional. Location string `json:"location,omitempty"` // Message: [Output Only] An optional, human-readable error message. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*OperationErrorErrors) MarshalJSON ¶
func (s *OperationErrorErrors) MarshalJSON() ([]byte, error)
type OperationWarnings ¶
type OperationWarnings struct { // Code: [Output Only] A warning code, if applicable. For example, // Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in // the response. Code string `json:"code,omitempty"` // Data: [Output Only] Metadata about this warning in key: value format. // For example: // "data": [ { "key": "scope", "value": "zones/us-east1-d" } Data []*OperationWarningsData `json:"data,omitempty"` // Message: [Output Only] A human-readable description of the warning // code. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*OperationWarnings) MarshalJSON ¶
func (s *OperationWarnings) MarshalJSON() ([]byte, error)
type OperationWarningsData ¶
type OperationWarningsData struct { // Key: [Output Only] A key that provides more detail on the warning // being returned. For example, for warnings where there are no results // in a list request for a particular zone, this key might be scope and // the key value might be the zone name. Other examples might be a key // indicating a deprecated resource and a suggested replacement, or a // warning about invalid network settings (for example, if an instance // attempts to perform IP forwarding but is not enabled for IP // forwarding). Key string `json:"key,omitempty"` // Value: [Output Only] A warning data value corresponding to the key. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Key") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Key") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*OperationWarningsData) MarshalJSON ¶
func (s *OperationWarningsData) MarshalJSON() ([]byte, error)
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "serviceregistry.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) IfNoneMatch ¶
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*OperationsListResponse, error)
Do executes the "serviceregistry.operations.list" call. Exactly one of *OperationsListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *OperationsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
func (*OperationsListCall) IfNoneMatch ¶
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*OperationsListCall) MaxResults ¶
func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
func (*OperationsListCall) OrderBy ¶
func (c *OperationsListCall) OrderBy(orderBy string) *OperationsListCall
OrderBy sets the optional parameter "orderBy": Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Currently, only sorting by name or creationTimestamp desc is supported.
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
func (*OperationsListCall) Pages ¶
func (c *OperationsListCall) Pages(ctx context.Context, f func(*OperationsListResponse) 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.
type OperationsListResponse ¶
type OperationsListResponse struct { // NextPageToken: [Output Only] A token used to continue a truncated // list request. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: [Output Only] Operations contained in this list response. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
OperationsListResponse: A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
func (*OperationsListResponse) MarshalJSON ¶
func (s *OperationsListResponse) MarshalJSON() ([]byte, error)
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Get ¶
func (r *OperationsService) Get(project string, operation string) *OperationsGetCall
Get: Gets information about a specific operation.
func (*OperationsService) List ¶
func (r *OperationsService) List(project string) *OperationsListCall
List: Lists all operations for a project.