Movatterモバイル変換

[0]ホーム
URL:

ids

package
v0.257.0Latest Latest
Warning

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

Go to latest Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package ids provides access to the Cloud IDS API.

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

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/ids/v1"...ctx := context.Background()idsService, err := ids.NewService(ctx)

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

Other authentication options

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

idsService, err := ids.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

Seegoogle.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

typeCancelOperationRequest

type CancelOperationRequest struct {}

CancelOperationRequest: The request message for Operations.CancelOperation.

typeEmpty

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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeEndpoint

type Endpoint struct {// CreateTime: Output only. The create time timestamp.CreateTimestring `json:"createTime,omitempty"`// Description: User-provided description of the endpointDescriptionstring `json:"description,omitempty"`// EndpointForwardingRule: Output only. The fully qualified URL of the// endpoint's ILB Forwarding Rule.EndpointForwardingRulestring `json:"endpointForwardingRule,omitempty"`// EndpointIp: Output only. The IP address of the IDS Endpoint's ILB.EndpointIpstring `json:"endpointIp,omitempty"`// Labels: The labels of the endpoint.Labels map[string]string `json:"labels,omitempty"`// Name: Output only. The name of the endpoint.Namestring `json:"name,omitempty"`// Network: Required. The fully qualified URL of the network to which the IDS// Endpoint is attached.Networkstring `json:"network,omitempty"`// SatisfiesPzi: Output only. [Output Only] Reserved for future use.SatisfiesPzibool `json:"satisfiesPzi,omitempty"`// SatisfiesPzs: Output only. [Output Only] Reserved for future use.SatisfiesPzsbool `json:"satisfiesPzs,omitempty"`// Severity: Required. Lowest threat severity that this endpoint will alert on.//// Possible values://   "SEVERITY_UNSPECIFIED" - Not set.//   "INFORMATIONAL" - Informational alerts.//   "LOW" - Low severity alerts.//   "MEDIUM" - Medium severity alerts.//   "HIGH" - High severity alerts.//   "CRITICAL" - Critical severity alerts.Severitystring `json:"severity,omitempty"`// State: Output only. Current state of the endpoint.//// Possible values://   "STATE_UNSPECIFIED" - Not set.//   "CREATING" - Being created.//   "READY" - Active and ready for traffic.//   "DELETING" - Being deleted.//   "UPDATING" - Being updated.Statestring `json:"state,omitempty"`// ThreatExceptions: List of threat IDs to be excepted from generating alerts.ThreatExceptions []string `json:"threatExceptions,omitempty"`// TrafficLogs: Whether the endpoint should report traffic logs in addition to// threat logs.TrafficLogsbool `json:"trafficLogs,omitempty"`// UpdateTime: Output only. The update time timestamp.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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:"-"`}

Endpoint: Endpoint describes a single IDS endpoint. It defines a forwardingrule to which packets can be sent for IDS inspection.

func (Endpoint)MarshalJSON

func (sEndpoint) MarshalJSON() ([]byte,error)

typeListEndpointsResponse

type ListEndpointsResponse struct {// Endpoints: The list of endpoints response.Endpoints []*Endpoint `json:"endpoints,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.NextPageTokenstring `json:"nextPageToken,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. "Endpoints") 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. "Endpoints") 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:"-"`}

func (ListEndpointsResponse)MarshalJSON

func (sListEndpointsResponse) MarshalJSON() ([]byte,error)

typeListLocationsResponse

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.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "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 (sListLocationsResponse) MarshalJSON() ([]byte,error)

typeListOperationsResponse

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections e.g. when attempting to list all resources across all supported// locations.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:"-"`}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse)MarshalJSON

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeLocation

type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `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".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `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 (sLocation) MarshalJSON() ([]byte,error)

typeOperation

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.Donebool `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.Metadatagoogleapi.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}`.Namestring `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`.Responsegoogleapi.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 theresult of a network API call.

func (Operation)MarshalJSON

func (sOperation) MarshalJSON() ([]byte,error)

typeOperationMetadata

type OperationMetadata struct {// ApiVersion: Output only. API version used to start the operation.ApiVersionstring `json:"apiVersion,omitempty"`// CreateTime: Output only. The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// EndTime: Output only. The time the operation finished running.EndTimestring `json:"endTime,omitempty"`// RequestedCancellation: Output only. Identifies whether the user has// requested cancellation of the operation. Operations that have successfully// been cancelled have google.longrunning.Operation.error value with a// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.RequestedCancellationbool `json:"requestedCancellation,omitempty"`// StatusMessage: Output only. Human-readable status of the operation, if any.StatusMessagestring `json:"statusMessage,omitempty"`// Target: Output only. Server-defined resource path for the target of the// operation.Targetstring `json:"target,omitempty"`// Verb: Output only. Name of the verb executed by the operation.Verbstring `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 (sOperationMetadata) MarshalJSON() ([]byte,error)

typeProjectsLocationsEndpointsCreateCall

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

func (*ProjectsLocationsEndpointsCreateCall)Context

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

func (*ProjectsLocationsEndpointsCreateCall)Do

Do executes the "ids.projects.locations.endpoints.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEndpointsCreateCall)EndpointId

EndpointId sets the optional parameter "endpointId": Required. The endpointidentifier. This will be part of the endpoint's resource name. This valuemust start with a lowercase letter followed by up to 62 lowercase letters,numbers, or hyphens, and cannot end with a hyphen. Values that do not matchthis pattern will trigger an INVALID_ARGUMENT error.

func (*ProjectsLocationsEndpointsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEndpointsCreateCall)Header

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

func (*ProjectsLocationsEndpointsCreateCall)RequestId

RequestId sets the optional parameter "requestId": An optional request ID toidentify requests. Specify a unique request ID so that if you must retryyour request, the server will know to ignore the request if it has alreadybeen completed. The server will guarantee that for at least 60 minutes sincethe first request. For example, consider a situation where you make aninitial request and the request times out. If you make the request againwith the same request ID, the server can check if original operation withthe same request ID was received, and if so, will ignore the second request.This prevents clients from accidentally creating duplicate commitments. Therequest ID must be a valid UUID with the exception that zero UUID is notsupported (00000000-0000-0000-0000-000000000000).

typeProjectsLocationsEndpointsDeleteCall

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

func (*ProjectsLocationsEndpointsDeleteCall)Context

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

func (*ProjectsLocationsEndpointsDeleteCall)Do

Do executes the "ids.projects.locations.endpoints.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEndpointsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEndpointsDeleteCall)Header

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

func (*ProjectsLocationsEndpointsDeleteCall)RequestId

RequestId sets the optional parameter "requestId": An optional request ID toidentify requests. Specify a unique request ID so that if you must retryyour request, the server will know to ignore the request if it has alreadybeen completed. The server will guarantee that for at least 60 minutes afterthe first request. For example, consider a situation where you make aninitial request and the request times out. If you make the request againwith the same request ID, the server can check if original operation withthe same request ID was received, and if so, will ignore the second request.This prevents clients from accidentally creating duplicate commitments. Therequest ID must be a valid UUID with the exception that zero UUID is notsupported (00000000-0000-0000-0000-000000000000).

typeProjectsLocationsEndpointsGetCall

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

func (*ProjectsLocationsEndpointsGetCall)Context

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

func (*ProjectsLocationsEndpointsGetCall)Do

Do executes the "ids.projects.locations.endpoints.get" call.Any non-2xx status code is an error. Response headers are in either*Endpoint.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEndpointsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEndpointsGetCall)Header

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

func (*ProjectsLocationsEndpointsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsEndpointsListCall

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

func (*ProjectsLocationsEndpointsListCall)Context

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

func (*ProjectsLocationsEndpointsListCall)Do

Do executes the "ids.projects.locations.endpoints.list" call.Any non-2xx status code is an error. Response headers are in either*ListEndpointsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsEndpointsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEndpointsListCall)Filter

Filter sets the optional parameter "filter": The filter expression,following the syntax outlined inhttps://google.aip.dev/160.

func (*ProjectsLocationsEndpointsListCall)Header

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

func (*ProjectsLocationsEndpointsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsEndpointsListCall)OrderBy

OrderBy sets the optional parameter "orderBy": One or more fields to compareand use to sort the output. Seehttps://google.aip.dev/132#ordering.

func (*ProjectsLocationsEndpointsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofendpoints to return. The service may return fewer than this value.

func (*ProjectsLocationsEndpointsListCall)PageToken

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

func (*ProjectsLocationsEndpointsListCall)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.

typeProjectsLocationsEndpointsPatchCalladded inv0.106.0

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

func (*ProjectsLocationsEndpointsPatchCall)Contextadded inv0.106.0

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

func (*ProjectsLocationsEndpointsPatchCall)Doadded inv0.106.0

Do executes the "ids.projects.locations.endpoints.patch" 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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsEndpointsPatchCall)Fieldsadded inv0.106.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsEndpointsPatchCall)Headeradded inv0.106.0

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

func (*ProjectsLocationsEndpointsPatchCall)RequestIdadded inv0.106.0

RequestId sets the optional parameter "requestId": An optional request ID toidentify requests. Specify a unique request ID so that if you must retryyour request, the server will know to ignore the request if it has alreadybeen completed. The server will guarantee that for at least 60 minutes sincethe first request. For example, consider a situation where you make aninitial request and the request times out. If you make the request againwith the same request ID, the server can check if original operation withthe same request ID was received, and if so, will ignore the second request.This prevents clients from accidentally creating duplicate commitments. Therequest ID must be a valid UUID with the exception that zero UUID is notsupported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsEndpointsPatchCall)UpdateMaskadded inv0.106.0

UpdateMask sets the optional parameter "updateMask": Field mask is used tospecify the fields to be overwritten in the Endpoint resource by the update.The fields specified in the update_mask are relative to the resource, notthe full request. A field will be overwritten if it is in the mask. If theuser does not provide a mask then all fields will be overwritten.

typeProjectsLocationsEndpointsService

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

funcNewProjectsLocationsEndpointsService

func NewProjectsLocationsEndpointsService(s *Service) *ProjectsLocationsEndpointsService

func (*ProjectsLocationsEndpointsService)Create

Create: Creates a new Endpoint in a given project and location.

- parent: The endpoint's parent.

func (*ProjectsLocationsEndpointsService)Delete

Delete: Deletes a single Endpoint.

- name: The name of the endpoint to delete.

func (*ProjectsLocationsEndpointsService)Get

Get: Gets details of a single Endpoint.

  • name: The name of the endpoint to retrieve. Format:projects/{project}/locations/{location}/endpoints/{endpoint}.

func (*ProjectsLocationsEndpointsService)List

List: Lists Endpoints in a given project and location.

- parent: The parent, which owns this collection of endpoints.

func (*ProjectsLocationsEndpointsService)Patchadded inv0.106.0

Patch: Updates the parameters of a single Endpoint.

- name: Output only. The name of the endpoint.

typeProjectsLocationsGetCall

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 "ids.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header

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

func (*ProjectsLocationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsListCall

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 "ids.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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsListCall)ExtraLocationTypesadded inv0.229.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter

Filter sets the optional parameter "filter": A filter to narrow down resultsto 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 addheaders to the request.

func (*ProjectsLocationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsListCall)PageSize

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

func (*ProjectsLocationsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive 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.

typeProjectsLocationsOperationsCancelCall

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 "ids.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsCancelCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsCancelCall)Header

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

typeProjectsLocationsOperationsDeleteCall

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 "ids.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsDeleteCall)Header

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

typeProjectsLocationsOperationsGetCall

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 "ids.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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

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

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCall

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 "ids.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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

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 addheaders to the request.

func (*ProjectsLocationsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSize

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

func (*ProjectsLocationsOperationsListCall)PageToken

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

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.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.255.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in the[ListOperationsResponse.unreachable] field. This can only be `true` whenreading across collections e.g. when `parent` is set to"projects/example/locations/-". This field is not by default supported andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

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

func (*ProjectsLocationsOperationsService)Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. Theserver makes a best effort to cancel the operation, but success is notguaranteed. If the server doesn't support this method, it returns`google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation orother methods to check whether the cancellation succeeded or whether theoperation completed despite cancellation. On successful cancellation, theoperation is not deleted; instead, it becomes an operation with anOperation.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 theclient is no longer interested in the operation result. It does not cancelthe 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 thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List

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

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

typeProjectsLocationsService

type ProjectsLocationsService struct {Endpoints *ProjectsLocationsEndpointsServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

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.

typeProjectsService

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

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService

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

NewService creates a new Service.

typeStatus

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `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 fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSON

func (sStatus) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp