apim

package
v0.200.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package apim provides access to the API Management API.

For product documentation, see: https://cloud.google.com/apigee/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any 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/apim/v1alpha"
...
ctx := context.Background()
apimService, err := apim.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

apimService, err := apim.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
apimService, err := apim.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
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

type ApiObservation

type ApiObservation struct {
	// ApiOperationCount: The number of observed API Operations.
	ApiOperationCount int64 `json:"apiOperationCount,omitempty,string"`
	// CreateTime: Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// Hostname: The hostname of requests processed for this Observation.
	Hostname string `json:"hostname,omitempty"`
	// LastEventDetectedTime: Last event detected time stamp
	LastEventDetectedTime string `json:"lastEventDetectedTime,omitempty"`
	// Name: Identifier. Name of resource
	Name string `json:"name,omitempty"`
	// ServerIps: The IP address (IPv4 or IPv6) of the origin server that the
	// request was sent to. This field can include port information. Examples:
	// "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
	ServerIps []string `json:"serverIps,omitempty"`
	// SourceLocations: Location of the Observation Source, for example
	// "us-central1" or "europe-west1."
	SourceLocations []string `json:"sourceLocations,omitempty"`
	// Style: Style of ApiObservation
	//
	// Possible values:
	//   "STYLE_UNSPECIFIED" - Unknown style
	//   "REST" - Style is Rest API
	//   "GRPC" - Style is Grpc API
	//   "GRAPHQL" - Style is GraphQL API
	Style string `json:"style,omitempty"`
	// Tags: User-defined tags to organize and sort
	Tags []string `json:"tags,omitempty"`
	// UpdateTime: Update time stamp
	UpdateTime string `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. "ApiOperationCount") 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. "ApiOperationCount") 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:"-"`
}

ApiObservation: Message describing ApiObservation object

func (ApiObservation) MarshalJSON

func (s ApiObservation) MarshalJSON() ([]byte, error)

type ApiOperation

type ApiOperation struct {
	// Count: The number of occurrences of this API Operation.
	Count int64 `json:"count,omitempty,string"`
	// FirstSeenTime: First seen time stamp
	FirstSeenTime string `json:"firstSeenTime,omitempty"`
	// HttpOperation: An HTTP Operation.
	HttpOperation *HttpOperation `json:"httpOperation,omitempty"`
	// LastSeenTime: Last seen time stamp
	LastSeenTime string `json:"lastSeenTime,omitempty"`
	// Name: Identifier. Name of resource
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

ApiOperation: Message describing ApiOperation object

func (ApiOperation) MarshalJSON

func (s ApiOperation) MarshalJSON() ([]byte, error)

type BatchEditTagsApiObservationsRequest added in v0.190.0

type BatchEditTagsApiObservationsRequest struct {
	// Requests: Required. The request message specifying the resources to update.
	// A maximum of 1000 apiObservations can be modified in a batch.
	Requests []*EditTagsApiObservationsRequest `json:"requests,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Requests") 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. "Requests") 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:"-"`
}

BatchEditTagsApiObservationsRequest: Message for requesting batch edit tags for ApiObservations

func (BatchEditTagsApiObservationsRequest) MarshalJSON added in v0.190.0

func (s BatchEditTagsApiObservationsRequest) MarshalJSON() ([]byte, error)

type BatchEditTagsApiObservationsResponse added in v0.190.0

type BatchEditTagsApiObservationsResponse struct {
	// ApiObservations: ApiObservations that were changed
	ApiObservations []*ApiObservation `json:"apiObservations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ApiObservations") 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. "ApiObservations") 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:"-"`
}

BatchEditTagsApiObservationsResponse: Message for response to edit Tags for ApiObservations

func (BatchEditTagsApiObservationsResponse) MarshalJSON added in v0.190.0

func (s BatchEditTagsApiObservationsResponse) MarshalJSON() ([]byte, error)

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type DisableObservationJobRequest

type DisableObservationJobRequest struct {
}

DisableObservationJobRequest: Message for disabling an ObservationJob

type EditTagsApiObservationsRequest added in v0.190.0

type EditTagsApiObservationsRequest struct {
	// ApiObservationId: Required. Identifier of ApiObservation need to be edit
	// tags Format example: "apigee.googleapis.com|us-west1|443"
	ApiObservationId string `json:"apiObservationId,omitempty"`
	// TagActions: Required. Tag actions to be applied
	TagActions []*TagAction `json:"tagActions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiObservationId") 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. "ApiObservationId") 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:"-"`
}

EditTagsApiObservationsRequest: Message for requesting edit tags for ApiObservation

func (EditTagsApiObservationsRequest) MarshalJSON added in v0.190.0

func (s EditTagsApiObservationsRequest) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EnableObservationJobRequest

type EnableObservationJobRequest struct {
}

EnableObservationJobRequest: Message for enabling an ObservationJob

type GclbObservationSource

type GclbObservationSource struct {
	// PscNetworkConfigs: Required. The VPC networks where traffic will be
	// observed. All load balancers within this network will be observed.
	// Currently, this is limited to only one network.
	PscNetworkConfigs []*GclbObservationSourcePscNetworkConfig `json:"pscNetworkConfigs,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PscNetworkConfigs") 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. "PscNetworkConfigs") 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:"-"`
}

GclbObservationSource: The GCLB observation source.

func (GclbObservationSource) MarshalJSON

func (s GclbObservationSource) MarshalJSON() ([]byte, error)

type GclbObservationSourcePscNetworkConfig

type GclbObservationSourcePscNetworkConfig struct {
	// Network: Required. The VPC network. Format:
	// `projects/{project_id}/global/networks/{network}`
	Network string `json:"network,omitempty"`
	// Subnetwork: Required. The subnetwork in the source region that will be used
	// to connect to the Cloud Load Balancers via PSC NEGs. Must belong to
	// `network`. Format:
	// projects/{project_id}/regions/{region}/subnetworks/{subnet}
	Subnetwork string `json:"subnetwork,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Network") 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. "Network") 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:"-"`
}

GclbObservationSourcePscNetworkConfig: Network information for setting up a PSC connection.

func (GclbObservationSourcePscNetworkConfig) MarshalJSON

func (s GclbObservationSourcePscNetworkConfig) MarshalJSON() ([]byte, error)

type HttpOperation

type HttpOperation struct {
	// Method: HTTP Method.
	//
	// Possible values:
	//   "HTTP_METHOD_UNSPECIFIED" - Unspecified HTTP method
	//   "GET" - GET HTTP method
	//   "HEAD" - HEAD HTTP method
	//   "POST" - POST HTTP method
	//   "PUT" - PUT HTTP method
	//   "PATCH" - PATCH HTTP method
	//   "DELETE" - DELETE HTTP method
	//   "TRACE" - TRACE HTTP method
	//   "OPTIONS" - OPTIONS HTTP method
	//   "CONNECT" - CONNECT HTTP method
	Method string `json:"method,omitempty"`
	// Path: Path of the HTTP request.
	Path string `json:"path,omitempty"`
	// PathParams: Path params of HttpOperation
	PathParams []*HttpOperationPathParam `json:"pathParams,omitempty"`
	// QueryParams: Query params of HttpOperation
	QueryParams map[string]HttpOperationQueryParam `json:"queryParams,omitempty"`
	// Request: Request metadata.
	Request *HttpOperationHttpRequest `json:"request,omitempty"`
	// Response: Response metadata.
	Response *HttpOperationHttpResponse `json:"response,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Method") 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. "Method") 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:"-"`
}

HttpOperation: An HTTP-based API Operation, sometimes called a "REST" Operation.

func (HttpOperation) MarshalJSON

func (s HttpOperation) MarshalJSON() ([]byte, error)

type HttpOperationHeader

type HttpOperationHeader struct {
	// Count: The number of occurrences of this Header across transactions.
	Count int64 `json:"count,omitempty,string"`
	// DataType: Data type of header
	//
	// Possible values:
	//   "DATA_TYPE_UNSPECIFIED" - Unspecified data type
	//   "BOOL" - Boolean data type
	//   "INTEGER" - Integer data type
	//   "FLOAT" - Float data type
	//   "STRING" - String data type
	//   "UUID" - UUID data type
	DataType string `json:"dataType,omitempty"`
	// Name: Header name.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

HttpOperationHeader: An aggregation of HTTP header occurrences.

func (HttpOperationHeader) MarshalJSON

func (s HttpOperationHeader) MarshalJSON() ([]byte, error)

type HttpOperationHttpRequest

type HttpOperationHttpRequest struct {
	// Headers: Unordered map from header name to header metadata
	Headers map[string]HttpOperationHeader `json:"headers,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Headers") 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. "Headers") 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:"-"`
}

HttpOperationHttpRequest: An aggregation of HTTP requests.

func (HttpOperationHttpRequest) MarshalJSON

func (s HttpOperationHttpRequest) MarshalJSON() ([]byte, error)

type HttpOperationHttpResponse

type HttpOperationHttpResponse struct {
	// Headers: Unordered map from header name to header metadata
	Headers map[string]HttpOperationHeader `json:"headers,omitempty"`
	// ResponseCodes: Map of status code to observed count
	ResponseCodes map[string]string `json:"responseCodes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Headers") 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. "Headers") 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:"-"`
}

HttpOperationHttpResponse: An aggregation of HTTP responses.

func (HttpOperationHttpResponse) MarshalJSON

func (s HttpOperationHttpResponse) MarshalJSON() ([]byte, error)

type HttpOperationPathParam

type HttpOperationPathParam struct {
	// DataType: Data type of path param
	//
	// Possible values:
	//   "DATA_TYPE_UNSPECIFIED" - Unspecified data type
	//   "BOOL" - Boolean data type
	//   "INTEGER" - Integer data type
	//   "FLOAT" - Float data type
	//   "STRING" - String data type
	//   "UUID" - UUID data type
	DataType string `json:"dataType,omitempty"`
	// Position: Segment location in the path, 1-indexed
	Position int64 `json:"position,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataType") 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. "DataType") 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:"-"`
}

HttpOperationPathParam: HTTP Path parameter.

func (HttpOperationPathParam) MarshalJSON

func (s HttpOperationPathParam) MarshalJSON() ([]byte, error)

type HttpOperationQueryParam

type HttpOperationQueryParam struct {
	// Count: The number of occurrences of this query parameter across
	// transactions.
	Count int64 `json:"count,omitempty,string"`
	// DataType: Data type of path param
	//
	// Possible values:
	//   "DATA_TYPE_UNSPECIFIED" - Unspecified data type
	//   "BOOL" - Boolean data type
	//   "INTEGER" - Integer data type
	//   "FLOAT" - Float data type
	//   "STRING" - String data type
	//   "UUID" - UUID data type
	DataType string `json:"dataType,omitempty"`
	// Name: Name of query param
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") 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. "Count") 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:"-"`
}

HttpOperationQueryParam: An aggregation of HTTP query parameter occurrences.

func (HttpOperationQueryParam) MarshalJSON

func (s HttpOperationQueryParam) MarshalJSON() ([]byte, error)

type ListApiObservationTagsResponse added in v0.190.0

type ListApiObservationTagsResponse struct {
	// ApiObservationTags: The tags from the specified project
	ApiObservationTags []string `json:"apiObservationTags,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "ApiObservationTags") 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. "ApiObservationTags") 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:"-"`
}

ListApiObservationTagsResponse: Message for response to listing tags

func (ListApiObservationTagsResponse) MarshalJSON added in v0.190.0

func (s ListApiObservationTagsResponse) MarshalJSON() ([]byte, error)

type ListApiObservationsResponse

type ListApiObservationsResponse struct {
	// ApiObservations: The ApiObservation from the specified project and location
	// and ObservationJobs.
	ApiObservations []*ApiObservation `json:"apiObservations,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "ApiObservations") 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. "ApiObservations") 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:"-"`
}

ListApiObservationsResponse: Message for response to listing ApiObservations

func (ListApiObservationsResponse) MarshalJSON

func (s ListApiObservationsResponse) MarshalJSON() ([]byte, error)

type ListApiOperationsResponse

type ListApiOperationsResponse struct {
	// ApiOperations: The ApiOperations from the specified project and location and
	// ObservationJob and ApiObservation.
	ApiOperations []*ApiOperation `json:"apiOperations,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "ApiOperations") 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. "ApiOperations") 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:"-"`
}

ListApiOperationsResponse: Message for response to listing ApiOperations

func (ListApiOperationsResponse) MarshalJSON

func (s ListApiOperationsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	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. "Locations") 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. "Locations") 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:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListObservationJobsResponse

type ListObservationJobsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ObservationJobs: The ObservationJob from the specified project and location.
	ObservationJobs []*ObservationJob `json:"observationJobs,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,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 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. "NextPageToken") 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:"-"`
}

ListObservationJobsResponse: Message for response to listing ObservationJobs

func (ListObservationJobsResponse) MarshalJSON

func (s ListObservationJobsResponse) MarshalJSON() ([]byte, error)

type ListObservationSourcesResponse

type ListObservationSourcesResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ObservationSources: The ObservationSource from the specified project and
	// location.
	ObservationSources []*ObservationSource `json:"observationSources,omitempty"`
	// Unreachable: Locations that could not be reached.
	Unreachable []string `json:"unreachable,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 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. "NextPageToken") 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:"-"`
}

ListObservationSourcesResponse: Message for response to listing ObservationSources

func (ListObservationSourcesResponse) MarshalJSON

func (s ListObservationSourcesResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	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 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. "NextPageToken") 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:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// 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:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type ObservationJob

type ObservationJob struct {
	// CreateTime: Output only. [Output only] Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// Name: Identifier. name of resource Format:
	// projects/{project}/locations/{location}/observationJobs/{observation_job}
	Name string `json:"name,omitempty"`
	// Sources: Optional. These should be of the same kind of source.
	Sources []string `json:"sources,omitempty"`
	// State: Output only. The observation job state
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state
	//   "CREATING" - Job is in the creating state
	//   "ENABLING" - Job is in the enabling state
	//   "ENABLED" - Job is enabled
	//   "DISABLING" - Job is in the disabling state
	//   "DISABLED" - Job is disabled
	//   "DELETING" - Job is being deleted
	//   "ERROR" - Job is in an error state
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. [Output only] Update time stamp
	UpdateTime string `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. "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:"-"`
}

ObservationJob: Message describing ObservationJob object

func (ObservationJob) MarshalJSON

func (s ObservationJob) MarshalJSON() ([]byte, error)

type ObservationSource

type ObservationSource struct {
	// CreateTime: Output only. [Output only] Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// GclbObservationSource: The GCLB observation source
	GclbObservationSource *GclbObservationSource `json:"gclbObservationSource,omitempty"`
	// Name: Identifier. name of resource For MVP, each region can only have 1
	// source.
	Name string `json:"name,omitempty"`
	// State: Output only. The observation source state
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state
	//   "CREATING" - Source is in the creating state
	//   "CREATED" - Source has been created and is ready to use
	//   "DELETING" - Source is being deleted
	//   "ERROR" - Source is in an error state
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. [Output only] Update time stamp
	UpdateTime string `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. "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:"-"`
}

ObservationSource: Observation source configuration types

func (ObservationSource) MarshalJSON

func (s ObservationSource) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been cancelled
	// successfully have Operation.error value with a google.rpc.Status.code of 1,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do

Do executes the "apim.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.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 (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an 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.

type ProjectsLocationsListApiObservationTagsCall added in v0.190.0

type ProjectsLocationsListApiObservationTagsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListApiObservationTagsCall) Context added in v0.190.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListApiObservationTagsCall) Do added in v0.190.0

Do executes the "apim.projects.locations.listApiObservationTags" call. Any non-2xx status code is an error. Response headers are in either *ListApiObservationTagsResponse.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 (*ProjectsLocationsListApiObservationTagsCall) Fields added in v0.190.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListApiObservationTagsCall) Header added in v0.190.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListApiObservationTagsCall) IfNoneMatch added in v0.190.0

IfNoneMatch sets an 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.

func (*ProjectsLocationsListApiObservationTagsCall) PageSize added in v0.190.0

PageSize sets the optional parameter "pageSize": The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsListApiObservationTagsCall) PageToken added in v0.190.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.

func (*ProjectsLocationsListApiObservationTagsCall) Pages added in v0.190.0

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 ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do

Do executes the "apim.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.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 (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an 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.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

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 ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall

type ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall) Do

Do executes the "apim.projects.locations.observationJobs.apiObservations.apiOperations.get" call. Any non-2xx status code is an error. Response headers are in either *ApiOperation.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 (*ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsGetCall) IfNoneMatch

IfNoneMatch sets an 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.

type ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall

type ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) Do

Do executes the "apim.projects.locations.observationJobs.apiObservations.apiOperations.list" call. Any non-2xx status code is an error. Response headers are in either *ListApiOperationsResponse.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 (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) IfNoneMatch

IfNoneMatch sets an 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.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` must match the call that provided the page token.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsListCall) Pages

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 ProjectsLocationsObservationJobsApiObservationsApiOperationsService

type ProjectsLocationsObservationJobsApiObservationsApiOperationsService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsService) Get

Get: GetApiOperation retrieves a single ApiOperation by name.

  • name: The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/a piObservations/{api_observation}/apiOperation/{api_operation}.

func (*ProjectsLocationsObservationJobsApiObservationsApiOperationsService) List

List: ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

  • parent: The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/a piObservations/{api_observation}.

type ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall added in v0.190.0

type ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall) Context added in v0.190.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall) Do added in v0.190.0

Do executes the "apim.projects.locations.observationJobs.apiObservations.batchEditTags" call. Any non-2xx status code is an error. Response headers are in either *BatchEditTagsApiObservationsResponse.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 (*ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall) Fields added in v0.190.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsApiObservationsBatchEditTagsCall) Header added in v0.190.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsObservationJobsApiObservationsGetCall

type ProjectsLocationsObservationJobsApiObservationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsApiObservationsGetCall) Do

Do executes the "apim.projects.locations.observationJobs.apiObservations.get" call. Any non-2xx status code is an error. Response headers are in either *ApiObservation.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 (*ProjectsLocationsObservationJobsApiObservationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsApiObservationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsApiObservationsGetCall) IfNoneMatch

IfNoneMatch sets an 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.

type ProjectsLocationsObservationJobsApiObservationsListCall

type ProjectsLocationsObservationJobsApiObservationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) Do

Do executes the "apim.projects.locations.observationJobs.apiObservations.list" call. Any non-2xx status code is an error. Response headers are in either *ListApiObservationsResponse.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 (*ProjectsLocationsObservationJobsApiObservationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) IfNoneMatch

IfNoneMatch sets an 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.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` must match the call that provided the page token.

func (*ProjectsLocationsObservationJobsApiObservationsListCall) Pages

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 ProjectsLocationsObservationJobsApiObservationsService

type ProjectsLocationsObservationJobsApiObservationsService struct {
	ApiOperations *ProjectsLocationsObservationJobsApiObservationsApiOperationsService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsApiObservationsService) BatchEditTags added in v0.190.0

BatchEditTags: BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

  • parent: The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}.

func (*ProjectsLocationsObservationJobsApiObservationsService) Get

Get: GetApiObservation retrieves a single ApiObservation by name.

  • name: The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/a piObservations/{api_observation}.

func (*ProjectsLocationsObservationJobsApiObservationsService) List

List: ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

  • parent: The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}.

type ProjectsLocationsObservationJobsCreateCall

type ProjectsLocationsObservationJobsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsCreateCall) Do

Do executes the "apim.projects.locations.observationJobs.create" call. 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 (*ProjectsLocationsObservationJobsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsCreateCall) ObservationJobId

ObservationJobId sets the optional parameter "observationJobId": Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/.

func (*ProjectsLocationsObservationJobsCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsObservationJobsDeleteCall

type ProjectsLocationsObservationJobsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsDeleteCall) Do

Do executes the "apim.projects.locations.observationJobs.delete" call. 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 (*ProjectsLocationsObservationJobsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsObservationJobsDisableCall

type ProjectsLocationsObservationJobsDisableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsDisableCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsDisableCall) Do

Do executes the "apim.projects.locations.observationJobs.disable" call. 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 (*ProjectsLocationsObservationJobsDisableCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsDisableCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsObservationJobsEnableCall

type ProjectsLocationsObservationJobsEnableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsEnableCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsEnableCall) Do

Do executes the "apim.projects.locations.observationJobs.enable" call. 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 (*ProjectsLocationsObservationJobsEnableCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsEnableCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsObservationJobsGetCall

type ProjectsLocationsObservationJobsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsGetCall) Do

Do executes the "apim.projects.locations.observationJobs.get" call. Any non-2xx status code is an error. Response headers are in either *ObservationJob.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 (*ProjectsLocationsObservationJobsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsGetCall) IfNoneMatch

IfNoneMatch sets an 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.

type ProjectsLocationsObservationJobsListCall

type ProjectsLocationsObservationJobsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationJobsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationJobsListCall) Do

Do executes the "apim.projects.locations.observationJobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListObservationJobsResponse.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 (*ProjectsLocationsObservationJobsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationJobsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationJobsListCall) IfNoneMatch

IfNoneMatch sets an 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.

func (*ProjectsLocationsObservationJobsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of ObservationJobs to return. The service may return fewer than this value. If unspecified, at most 10 ObservationJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsObservationJobsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListObservationJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationJobs` must match the call that provided the page token.

func (*ProjectsLocationsObservationJobsListCall) Pages

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 ProjectsLocationsObservationJobsService

type ProjectsLocationsObservationJobsService struct {
	ApiObservations *ProjectsLocationsObservationJobsApiObservationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsObservationJobsService

func NewProjectsLocationsObservationJobsService(s *Service) *ProjectsLocationsObservationJobsService

func (*ProjectsLocationsObservationJobsService) Create

Create: CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.

  • parent: The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}.

func (*ProjectsLocationsObservationJobsService) Delete

Delete: DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.

  • name: Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}.

func (*ProjectsLocationsObservationJobsService) Disable

Disable: Disables the given ObservationJob.

  • name: The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job}.

func (*ProjectsLocationsObservationJobsService) Enable

Enable: Enables the given ObservationJob.

  • name: The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job}.

func (*ProjectsLocationsObservationJobsService) Get

Get: GetObservationJob retrieves a single ObservationJob by name.

  • name: The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job}.

func (*ProjectsLocationsObservationJobsService) List

List: ListObservationJobs gets all ObservationJobs for a given project and location.

  • parent: The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}.

type ProjectsLocationsObservationSourcesCreateCall

type ProjectsLocationsObservationSourcesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationSourcesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationSourcesCreateCall) Do

Do executes the "apim.projects.locations.observationSources.create" call. 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 (*ProjectsLocationsObservationSourcesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationSourcesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationSourcesCreateCall) ObservationSourceId

ObservationSourceId sets the optional parameter "observationSourceId": Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/.

func (*ProjectsLocationsObservationSourcesCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsObservationSourcesDeleteCall

type ProjectsLocationsObservationSourcesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationSourcesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationSourcesDeleteCall) Do

Do executes the "apim.projects.locations.observationSources.delete" call. 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 (*ProjectsLocationsObservationSourcesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationSourcesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsObservationSourcesGetCall

type ProjectsLocationsObservationSourcesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationSourcesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationSourcesGetCall) Do

Do executes the "apim.projects.locations.observationSources.get" call. Any non-2xx status code is an error. Response headers are in either *ObservationSource.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 (*ProjectsLocationsObservationSourcesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationSourcesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationSourcesGetCall) IfNoneMatch

IfNoneMatch sets an 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.

type ProjectsLocationsObservationSourcesListCall

type ProjectsLocationsObservationSourcesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsObservationSourcesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsObservationSourcesListCall) Do

Do executes the "apim.projects.locations.observationSources.list" call. Any non-2xx status code is an error. Response headers are in either *ListObservationSourcesResponse.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 (*ProjectsLocationsObservationSourcesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsObservationSourcesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsObservationSourcesListCall) IfNoneMatch

IfNoneMatch sets an 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.

func (*ProjectsLocationsObservationSourcesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of ObservationSources to return. The service may return fewer than this value. If unspecified, at most 10 ObservationSources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsObservationSourcesListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListObservationSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationSources` must match the call that provided the page token.

func (*ProjectsLocationsObservationSourcesListCall) Pages

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 ProjectsLocationsObservationSourcesService

type ProjectsLocationsObservationSourcesService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsObservationSourcesService

func NewProjectsLocationsObservationSourcesService(s *Service) *ProjectsLocationsObservationSourcesService

func (*ProjectsLocationsObservationSourcesService) Create

Create: CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

- parent: Value for parent.

func (*ProjectsLocationsObservationSourcesService) Delete

Delete: DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.

  • name: Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source}.

func (*ProjectsLocationsObservationSourcesService) Get

Get: GetObservationSource retrieves a single ObservationSource by name.

  • name: The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source}.

func (*ProjectsLocationsObservationSourcesService) List

List: ListObservationSources gets all ObservationSources for a given project and location.

  • parent: The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}.

type ProjectsLocationsOperationsCancelCall

type ProjectsLocationsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsCancelCall) Do

Do executes the "apim.projects.locations.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsOperationsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsDeleteCall

type ProjectsLocationsOperationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsDeleteCall) Do

Do executes the "apim.projects.locations.operations.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsOperationsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall) Do

Do executes the "apim.projects.locations.operations.get" call. 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 (*ProjectsLocationsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

IfNoneMatch sets an 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.

type ProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall) Do

Do executes the "apim.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*ProjectsLocationsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

IfNoneMatch sets an 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.

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) Pages

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 ProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	ObservationJobs *ProjectsLocationsObservationJobsService

	ObservationSources *ProjectsLocationsObservationSourcesService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

func (*ProjectsLocationsService) ListApiObservationTags added in v0.190.0

ListApiObservationTags: ListApiObservationTags lists all extant tags on any observation in the given project.

  • parent: The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

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.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	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 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. "Code") 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:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type TagAction added in v0.190.0

type TagAction struct {
	// Action: Required. Action to be applied
	//
	// Possible values:
	//   "ACTION_UNSPECIFIED" - Unspecified.
	//   "ADD" - Addition of a Tag.
	//   "REMOVE" - Removal of a Tag.
	Action string `json:"action,omitempty"`
	// Tag: Required. Tag to be added or removed
	Tag string `json:"tag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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:"-"`
}

TagAction: Message for edit tag action

func (TagAction) MarshalJSON added in v0.190.0

func (s TagAction) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL