servicedirectory

package
v0.214.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package servicedirectory provides access to the Service Directory API.

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

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/servicedirectory/v1beta1"
...
ctx := context.Background()
servicedirectoryService, err := servicedirectory.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:

servicedirectoryService, err := servicedirectory.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, ...)
servicedirectoryService, err := servicedirectory.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 APIService

type APIService 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) (*APIService, error)

New creates a new APIService. 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) (*APIService, error)

NewService creates a new APIService.

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") 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. "Condition") 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:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON

func (s Binding) 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 Endpoint

type Endpoint struct {
	// Address: Optional. An IPv4 or IPv6 address. Service Directory rejects bad
	// addresses like: * `8.8.8` * `8.8.8.8:53` * `test:bad:address` * `[::1]` *
	// `[::1]:8080` Limited to 45 characters.
	Address string `json:"address,omitempty"`
	// CreateTime: Output only. The timestamp when the endpoint was created.
	CreateTime string `json:"createTime,omitempty"`
	// Metadata: Optional. Metadata for the endpoint. This data can be consumed by
	// service clients. Restrictions: * The entire metadata dictionary may contain
	// up to 512 characters, spread accoss all key-value pairs. Metadata that goes
	// beyond this limit are rejected * Valid metadata keys have two segments: an
	// optional prefix and name, separated by a slash (/). The name segment is
	// required and must be 63 characters or less, beginning and ending with an
	// alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots
	// (.), and alphanumerics between. The prefix is optional. If specified, the
	// prefix must be a DNS subdomain: a series of DNS labels separated by dots
	// (.), not longer than 253 characters in total, followed by a slash (/).
	// Metadata that fails to meet these requirements are rejected Note: This field
	// is equivalent to the `annotations` field in the v1 API. They have the same
	// syntax and read/write to the same location in Service Directory.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Name: Immutable. The resource name for the endpoint in the format
	// `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
	Name string `json:"name,omitempty"`
	// Network: Immutable. The Google Compute Engine network (VPC) of the endpoint
	// in the format `projects//locations/global/networks/*`. The project must be
	// specified by project number (project id is rejected). Incorrectly formatted
	// networks are rejected, but no other validation is performed on this field
	// (ex. network or project existence, reachability, or permissions).
	Network string `json:"network,omitempty"`
	// Port: Optional. Service Directory rejects values outside of `[0, 65535]`.
	Port int64 `json:"port,omitempty"`
	// Uid: Output only. A globally unique identifier (in UUID4 format) for this
	// endpoint.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. The timestamp when the endpoint was last updated.
	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. "Address") 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. "Address") 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: An individual endpoint that provides a service. The service must already exist to create an endpoint.

func (Endpoint) MarshalJSON

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

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON

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

type GetIamPolicyRequest

type GetIamPolicyRequest struct {
	// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
	// `GetIamPolicy`.
	Options *GetPolicyOptions `json:"options,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Options") 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. "Options") 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:"-"`
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (GetIamPolicyRequest) MarshalJSON

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

type GetPolicyOptions

type GetPolicyOptions struct {
	// RequestedPolicyVersion: Optional. The maximum policy version that will be
	// used to format the policy. Valid values are 0, 1, and 3. Requests specifying
	// an invalid value will be rejected. Requests for policies with any
	// conditional role bindings must specify version 3. Policies with no
	// conditional role bindings may specify any valid value or leave the field
	// unset. The policy in the response might use the policy version that you
	// specified, or it might use a lower policy version. For example, if you
	// specify version 3, but the policy has no conditional role bindings, the
	// response uses version 1. To learn which resources support conditions in
	// their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestedPolicyVersion") 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. "RequestedPolicyVersion") 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:"-"`
}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (GetPolicyOptions) MarshalJSON

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

type ListEndpointsResponse

type ListEndpointsResponse struct {
	// Endpoints: The list of endpoints.
	Endpoints []*Endpoint `json:"endpoints,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Endpoints") to
	// unconditionally include in API requests. By default, fields with empty 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:"-"`
}

ListEndpointsResponse: The response message for RegistrationService.ListEndpoints.

func (ListEndpointsResponse) MarshalJSON

func (s ListEndpointsResponse) 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 ListNamespacesResponse

type ListNamespacesResponse struct {
	// Namespaces: The list of namespaces.
	Namespaces []*Namespace `json:"namespaces,omitempty"`
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	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. "Namespaces") 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. "Namespaces") 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:"-"`
}

ListNamespacesResponse: The response message for RegistrationService.ListNamespaces.

func (ListNamespacesResponse) MarshalJSON

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

type ListServicesResponse

type ListServicesResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty if there
	// are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Services: The list of services.
	Services []*Service `json:"services,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:"-"`
}

ListServicesResponse: The response message for RegistrationService.ListServices.

func (ListServicesResponse) MarshalJSON

func (s ListServicesResponse) 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 Namespace

type Namespace struct {
	// CreateTime: Output only. The timestamp when the namespace was created.
	CreateTime string `json:"createTime,omitempty"`
	// Labels: Optional. Resource labels associated with this namespace. No more
	// than 64 user labels can be associated with a given resource. Label keys and
	// values can be no longer than 63 characters.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Immutable. The resource name for the namespace in the format
	// `projects/*/locations/*/namespaces/*`.
	Name string `json:"name,omitempty"`
	// Uid: Output only. A globally unique identifier (in UUID4 format) for this
	// namespace.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. The timestamp when the namespace was last updated.
	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:"-"`
}

Namespace: A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

func (Namespace) MarshalJSON

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

type Policy

type Policy struct {
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

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

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) 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 "servicedirectory.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 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 "servicedirectory.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 ProjectsLocationsNamespacesCreateCall

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

func (*ProjectsLocationsNamespacesCreateCall) Context

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

func (*ProjectsLocationsNamespacesCreateCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.create" call. Any non-2xx status code is an error. Response headers are in either *Namespace.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 (*ProjectsLocationsNamespacesCreateCall) Fields

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

func (*ProjectsLocationsNamespacesCreateCall) Header

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

func (*ProjectsLocationsNamespacesCreateCall) NamespaceId

NamespaceId sets the optional parameter "namespaceId": Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

type ProjectsLocationsNamespacesDeleteCall

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

func (*ProjectsLocationsNamespacesDeleteCall) Context

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

func (*ProjectsLocationsNamespacesDeleteCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.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 (*ProjectsLocationsNamespacesDeleteCall) Fields

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

func (*ProjectsLocationsNamespacesDeleteCall) Header

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

type ProjectsLocationsNamespacesGetCall

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

func (*ProjectsLocationsNamespacesGetCall) Context

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

func (*ProjectsLocationsNamespacesGetCall) Do

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

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

func (*ProjectsLocationsNamespacesGetCall) Header

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

func (*ProjectsLocationsNamespacesGetCall) 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 ProjectsLocationsNamespacesGetIamPolicyCall

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

func (*ProjectsLocationsNamespacesGetIamPolicyCall) Context

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

func (*ProjectsLocationsNamespacesGetIamPolicyCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesGetIamPolicyCall) Fields

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

func (*ProjectsLocationsNamespacesGetIamPolicyCall) Header

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

type ProjectsLocationsNamespacesListCall

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

func (*ProjectsLocationsNamespacesListCall) Context

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

func (*ProjectsLocationsNamespacesListCall) Do

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

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

func (*ProjectsLocationsNamespacesListCall) Filter

Filter sets the optional parameter "filter": The filter to list results by. General `filter` string syntax: ` ()` * “ can be `name`, `labels.` for map field, or `attributes.` for attributes field * “ can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:` means `HAS`, and is roughly the same as `=` * “ must be the same data type as field * “ can be `AND`, `OR`, `NOT` Examples of valid filters: * `labels.owner` returns namespaces that have a label with the key `owner`, this is the same as `labels:owner` * `labels.owner=sd` returns namespaces that have key/value `owner=sd` * `name>projects/my-project/locations/us-east1/namespaces/namespace-c` returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is not * `labels.owner!=sd AND labels.foo=bar` returns namespaces that have `owner` in label key but value is not `sd` AND have key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no results * `attributes.managed_registration=true` returns namespaces that are managed by a GCP product or service For more information about filtering, see API Filtering (https://aip.dev/160).

func (*ProjectsLocationsNamespacesListCall) Header

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

func (*ProjectsLocationsNamespacesListCall) 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 (*ProjectsLocationsNamespacesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": The order to list results by. General `order_by` string syntax: ` () (,)` * “ allows value: `name` * “ ascending or descending order by “. If this is left blank, `asc` is used Note that an empty `order_by` string results in default order, which is order by `name` in ascending order.

func (*ProjectsLocationsNamespacesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return. The default value is 100.

func (*ProjectsLocationsNamespacesListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsNamespacesListCall) 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 ProjectsLocationsNamespacesPatchCall

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

func (*ProjectsLocationsNamespacesPatchCall) Context

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

func (*ProjectsLocationsNamespacesPatchCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.patch" call. Any non-2xx status code is an error. Response headers are in either *Namespace.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 (*ProjectsLocationsNamespacesPatchCall) Fields

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

func (*ProjectsLocationsNamespacesPatchCall) Header

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

func (*ProjectsLocationsNamespacesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. List of fields to be updated in this request.

type ProjectsLocationsNamespacesService

type ProjectsLocationsNamespacesService struct {
	Services *ProjectsLocationsNamespacesServicesService

	Workloads *ProjectsLocationsNamespacesWorkloadsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsNamespacesService

func NewProjectsLocationsNamespacesService(s *APIService) *ProjectsLocationsNamespacesService

func (*ProjectsLocationsNamespacesService) Create

Create: Creates a namespace, and returns the new namespace.

  • parent: The resource name of the project and location the namespace will be created in.

func (*ProjectsLocationsNamespacesService) Delete

Delete: Deletes a namespace. This also deletes all services and endpoints in the namespace.

- name: The name of the namespace to delete.

func (*ProjectsLocationsNamespacesService) Get

Get: Gets a namespace.

- name: The name of the namespace to retrieve.

func (*ProjectsLocationsNamespacesService) GetIamPolicy

GetIamPolicy: Gets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesService) List

List: Lists all namespaces.

  • parent: The resource name of the project and location whose namespaces you'd like to list.

func (*ProjectsLocationsNamespacesService) Patch

Patch: Updates a namespace.

  • name: Immutable. The resource name for the namespace in the format `projects/*/locations/*/namespaces/*`.

func (*ProjectsLocationsNamespacesService) SetIamPolicy

SetIamPolicy: Sets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesService) TestIamPermissions

TestIamPermissions: Tests IAM permissions for a resource (namespace, service or service workload only).

type ProjectsLocationsNamespacesServicesCreateCall

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

func (*ProjectsLocationsNamespacesServicesCreateCall) Context

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

func (*ProjectsLocationsNamespacesServicesCreateCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.create" call. Any non-2xx status code is an error. Response headers are in either *Service.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 (*ProjectsLocationsNamespacesServicesCreateCall) Fields

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

func (*ProjectsLocationsNamespacesServicesCreateCall) Header

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

func (*ProjectsLocationsNamespacesServicesCreateCall) ServiceId

ServiceId sets the optional parameter "serviceId": Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

type ProjectsLocationsNamespacesServicesDeleteCall

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

func (*ProjectsLocationsNamespacesServicesDeleteCall) Context

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

func (*ProjectsLocationsNamespacesServicesDeleteCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.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 (*ProjectsLocationsNamespacesServicesDeleteCall) Fields

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

func (*ProjectsLocationsNamespacesServicesDeleteCall) Header

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

type ProjectsLocationsNamespacesServicesEndpointsCreateCall

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

func (*ProjectsLocationsNamespacesServicesEndpointsCreateCall) Context

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

func (*ProjectsLocationsNamespacesServicesEndpointsCreateCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.endpoints.create" 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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsNamespacesServicesEndpointsCreateCall) EndpointId

EndpointId sets the optional parameter "endpointId": Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

func (*ProjectsLocationsNamespacesServicesEndpointsCreateCall) Fields

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

func (*ProjectsLocationsNamespacesServicesEndpointsCreateCall) Header

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

type ProjectsLocationsNamespacesServicesEndpointsDeleteCall

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

func (*ProjectsLocationsNamespacesServicesEndpointsDeleteCall) Context

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

func (*ProjectsLocationsNamespacesServicesEndpointsDeleteCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.endpoints.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 (*ProjectsLocationsNamespacesServicesEndpointsDeleteCall) Fields

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

func (*ProjectsLocationsNamespacesServicesEndpointsDeleteCall) Header

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

type ProjectsLocationsNamespacesServicesEndpointsGetCall

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

func (*ProjectsLocationsNamespacesServicesEndpointsGetCall) Context

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

func (*ProjectsLocationsNamespacesServicesEndpointsGetCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsNamespacesServicesEndpointsGetCall) Fields

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

func (*ProjectsLocationsNamespacesServicesEndpointsGetCall) Header

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

func (*ProjectsLocationsNamespacesServicesEndpointsGetCall) 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 ProjectsLocationsNamespacesServicesEndpointsListCall

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

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) Context

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

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.endpoints.list" call. Any non-2xx status code is an error. Response headers are in either *ListEndpointsResponse.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 (*ProjectsLocationsNamespacesServicesEndpointsListCall) Fields

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

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) Filter

Filter sets the optional parameter "filter": The filter to list results by. General `filter` string syntax: ` ()` * “ can be `name`, `address`, `port`, `metadata.` for map field, or `attributes.` for attributes field * “ can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:` means `HAS`, and is roughly the same as `=` * “ must be the same data type as field * “ can be `AND`, `OR`, `NOT` Examples of valid filters: * `metadata.owner` returns endpoints that have a metadata with the key `owner`, this is the same as `metadata:owner` * `metadata.protocol=gRPC` returns endpoints that have key/value `protocol=gRPC` * `address=192.108.1.105` returns endpoints that have this address * `port>8080` returns endpoints that have port number larger than 8080 * `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services /my-service/endpoints/endpoint-c` returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not * `metadata.owner!=sd AND metadata.foo=bar` returns endpoints that have `owner` in metadata key but value is not `sd` AND have key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results * `attributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP` returns endpoints with the corresponding kubernetes_resource_type For more information about filtering, see API Filtering (https://aip.dev/160).

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) Header

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

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) 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 (*ProjectsLocationsNamespacesServicesEndpointsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": The order to list results by. General `order_by` string syntax: ` () (,)` * “ allows values: `name`, `address`, `port` * “ ascending or descending order by “. If this is left blank, `asc` is used Note that an empty `order_by` string results in default order, which is order by `name` in ascending order.

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return. The default value is 100.

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsNamespacesServicesEndpointsListCall) 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 ProjectsLocationsNamespacesServicesEndpointsPatchCall

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

func (*ProjectsLocationsNamespacesServicesEndpointsPatchCall) Context

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

func (*ProjectsLocationsNamespacesServicesEndpointsPatchCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.endpoints.patch" 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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsNamespacesServicesEndpointsPatchCall) Fields

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

func (*ProjectsLocationsNamespacesServicesEndpointsPatchCall) Header

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

func (*ProjectsLocationsNamespacesServicesEndpointsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. List of fields to be updated in this request.

type ProjectsLocationsNamespacesServicesEndpointsService

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

func (*ProjectsLocationsNamespacesServicesEndpointsService) Create

Create: Creates an endpoint, and returns the new endpoint.

- parent: The resource name of the service that this endpoint provides.

func (*ProjectsLocationsNamespacesServicesEndpointsService) Delete

Delete: Deletes an endpoint.

- name: The name of the endpoint to delete.

func (*ProjectsLocationsNamespacesServicesEndpointsService) Get

Get: Gets an endpoint.

- name: The name of the endpoint to get.

func (*ProjectsLocationsNamespacesServicesEndpointsService) List

List: Lists all endpoints.

  • parent: The resource name of the service whose endpoints you'd like to list.

func (*ProjectsLocationsNamespacesServicesEndpointsService) Patch

Patch: Updates an endpoint.

  • name: Immutable. The resource name for the endpoint in the format `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.

type ProjectsLocationsNamespacesServicesGetCall

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

func (*ProjectsLocationsNamespacesServicesGetCall) Context

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

func (*ProjectsLocationsNamespacesServicesGetCall) Do

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

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

func (*ProjectsLocationsNamespacesServicesGetCall) Header

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

func (*ProjectsLocationsNamespacesServicesGetCall) 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 ProjectsLocationsNamespacesServicesGetIamPolicyCall

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

func (*ProjectsLocationsNamespacesServicesGetIamPolicyCall) Context

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

func (*ProjectsLocationsNamespacesServicesGetIamPolicyCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesServicesGetIamPolicyCall) Fields

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

func (*ProjectsLocationsNamespacesServicesGetIamPolicyCall) Header

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

type ProjectsLocationsNamespacesServicesListCall

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

func (*ProjectsLocationsNamespacesServicesListCall) Context

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

func (*ProjectsLocationsNamespacesServicesListCall) Do

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

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

func (*ProjectsLocationsNamespacesServicesListCall) Filter

Filter sets the optional parameter "filter": The filter to list results by. General `filter` string syntax: ` ()` * “ can be `name` or `metadata.` for map field * “ can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:` means `HAS`, and is roughly the same as `=` * “ must be the same data type as field * “ can be `AND`, `OR`, `NOT` Examples of valid filters: * `metadata.owner` returns services that have a metadata with the key `owner`, this is the same as `metadata:owner` * `metadata.protocol=gRPC` returns services that have key/value `protocol=gRPC` * `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services /service-c` returns services that have name that is alphabetically later than the string, so "service-e" is returned but "service-a" is not * `metadata.owner!=sd AND metadata.foo=bar` returns services that have `owner` in metadata key but value is not `sd` AND have key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note that service doesn't have a field called "doesnotexist". Since the filter does not match any services, it returns no results * `attributes.managed_registration=true` returns services that are managed by a GCP product or service For more information about filtering, see API Filtering (https://aip.dev/160).

func (*ProjectsLocationsNamespacesServicesListCall) Header

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

func (*ProjectsLocationsNamespacesServicesListCall) 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 (*ProjectsLocationsNamespacesServicesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": The order to list results by. General `order_by` string syntax: ` () (,)` * “ allows value: `name` * “ ascending or descending order by “. If this is left blank, `asc` is used Note that an empty `order_by` string results in default order, which is order by `name` in ascending order.

func (*ProjectsLocationsNamespacesServicesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return. The default value is 100.

func (*ProjectsLocationsNamespacesServicesListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsNamespacesServicesListCall) 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 ProjectsLocationsNamespacesServicesPatchCall

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

func (*ProjectsLocationsNamespacesServicesPatchCall) Context

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

func (*ProjectsLocationsNamespacesServicesPatchCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.patch" call. Any non-2xx status code is an error. Response headers are in either *Service.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 (*ProjectsLocationsNamespacesServicesPatchCall) Fields

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

func (*ProjectsLocationsNamespacesServicesPatchCall) Header

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

func (*ProjectsLocationsNamespacesServicesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. List of fields to be updated in this request.

type ProjectsLocationsNamespacesServicesResolveCall

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

func (*ProjectsLocationsNamespacesServicesResolveCall) Context

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

func (*ProjectsLocationsNamespacesServicesResolveCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.resolve" call. Any non-2xx status code is an error. Response headers are in either *ResolveServiceResponse.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 (*ProjectsLocationsNamespacesServicesResolveCall) Fields

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

func (*ProjectsLocationsNamespacesServicesResolveCall) Header

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

type ProjectsLocationsNamespacesServicesService

type ProjectsLocationsNamespacesServicesService struct {
	Endpoints *ProjectsLocationsNamespacesServicesEndpointsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsNamespacesServicesService

func NewProjectsLocationsNamespacesServicesService(s *APIService) *ProjectsLocationsNamespacesServicesService

func (*ProjectsLocationsNamespacesServicesService) Create

Create: Creates a service, and returns the new service.

- parent: The resource name of the namespace this service will belong to.

func (*ProjectsLocationsNamespacesServicesService) Delete

Delete: Deletes a service. This also deletes all endpoints associated with the service.

- name: The name of the service to delete.

func (*ProjectsLocationsNamespacesServicesService) Get

Get: Gets a service.

- name: The name of the service to get.

func (*ProjectsLocationsNamespacesServicesService) GetIamPolicy

GetIamPolicy: Gets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesServicesService) List

List: Lists all services belonging to a namespace.

  • parent: The resource name of the namespace whose services you'd like to list.

func (*ProjectsLocationsNamespacesServicesService) Patch

Patch: Updates a service.

  • name: Immutable. The resource name for the service in the format `projects/*/locations/*/namespaces/*/services/*`.

func (*ProjectsLocationsNamespacesServicesService) Resolve

Resolve: Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.

- name: The name of the service to resolve.

func (*ProjectsLocationsNamespacesServicesService) SetIamPolicy

SetIamPolicy: Sets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesServicesService) TestIamPermissions

TestIamPermissions: Tests IAM permissions for a resource (namespace, service or service workload only).

type ProjectsLocationsNamespacesServicesSetIamPolicyCall

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

func (*ProjectsLocationsNamespacesServicesSetIamPolicyCall) Context

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

func (*ProjectsLocationsNamespacesServicesSetIamPolicyCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesServicesSetIamPolicyCall) Fields

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

func (*ProjectsLocationsNamespacesServicesSetIamPolicyCall) Header

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

type ProjectsLocationsNamespacesServicesTestIamPermissionsCall

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

func (*ProjectsLocationsNamespacesServicesTestIamPermissionsCall) Context

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

func (*ProjectsLocationsNamespacesServicesTestIamPermissionsCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.services.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsLocationsNamespacesServicesTestIamPermissionsCall) Fields

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

func (*ProjectsLocationsNamespacesServicesTestIamPermissionsCall) Header

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

type ProjectsLocationsNamespacesSetIamPolicyCall

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

func (*ProjectsLocationsNamespacesSetIamPolicyCall) Context

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

func (*ProjectsLocationsNamespacesSetIamPolicyCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesSetIamPolicyCall) Fields

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

func (*ProjectsLocationsNamespacesSetIamPolicyCall) Header

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

type ProjectsLocationsNamespacesTestIamPermissionsCall

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

func (*ProjectsLocationsNamespacesTestIamPermissionsCall) Context

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

func (*ProjectsLocationsNamespacesTestIamPermissionsCall) Do

Do executes the "servicedirectory.projects.locations.namespaces.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsLocationsNamespacesTestIamPermissionsCall) Fields

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

func (*ProjectsLocationsNamespacesTestIamPermissionsCall) Header

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

type ProjectsLocationsNamespacesWorkloadsGetIamPolicyCall added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsGetIamPolicyCall) Context added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsGetIamPolicyCall) Do added in v0.111.0

Do executes the "servicedirectory.projects.locations.namespaces.workloads.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesWorkloadsGetIamPolicyCall) Fields added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsGetIamPolicyCall) Header added in v0.111.0

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

type ProjectsLocationsNamespacesWorkloadsService added in v0.111.0

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

func NewProjectsLocationsNamespacesWorkloadsService added in v0.111.0

func NewProjectsLocationsNamespacesWorkloadsService(s *APIService) *ProjectsLocationsNamespacesWorkloadsService

func (*ProjectsLocationsNamespacesWorkloadsService) GetIamPolicy added in v0.111.0

GetIamPolicy: Gets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesWorkloadsService) SetIamPolicy added in v0.111.0

SetIamPolicy: Sets the IAM Policy for a resource

func (*ProjectsLocationsNamespacesWorkloadsService) TestIamPermissions added in v0.111.0

TestIamPermissions: Tests IAM permissions for a resource (namespace, service or service workload only).

type ProjectsLocationsNamespacesWorkloadsSetIamPolicyCall added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsSetIamPolicyCall) Context added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsSetIamPolicyCall) Do added in v0.111.0

Do executes the "servicedirectory.projects.locations.namespaces.workloads.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsLocationsNamespacesWorkloadsSetIamPolicyCall) Fields added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsSetIamPolicyCall) Header added in v0.111.0

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

type ProjectsLocationsNamespacesWorkloadsTestIamPermissionsCall added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsTestIamPermissionsCall) Context added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsTestIamPermissionsCall) Do added in v0.111.0

Do executes the "servicedirectory.projects.locations.namespaces.workloads.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsLocationsNamespacesWorkloadsTestIamPermissionsCall) Fields added in v0.111.0

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

func (*ProjectsLocationsNamespacesWorkloadsTestIamPermissionsCall) Header added in v0.111.0

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

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Namespaces *ProjectsLocationsNamespacesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *APIService) *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.

type ProjectsService

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

func NewProjectsService

func NewProjectsService(s *APIService) *ProjectsService

type ResolveServiceRequest

type ResolveServiceRequest struct {
	// EndpointFilter: Optional. The filter applied to the endpoints of the
	// resolved service. General `filter` string syntax: ` ()` * “ can be `name`,
	// `address`, `port`, or `metadata.` for map field * “ can be `<`, `>`, `<=`,
	// `>=`, `!=`, `=`, `:`. Of which `:` means `HAS`, and is roughly the same as
	// `=` * “ must be the same data type as field * “ can be `AND`, `OR`, `NOT`
	// Examples of valid filters: * `metadata.owner` returns endpoints that have a
	// annotation with the key `owner`, this is the same as `metadata:owner` *
	// `metadata.protocol=gRPC` returns endpoints that have key/value
	// `protocol=gRPC` * `address=192.108.1.105` returns endpoints that have this
	// address * `port>8080` returns endpoints that have port number larger than
	// 8080 *
	// `name>projects/my-project/locations/us-east1/namespaces/my-namespace/services
	// /my-service/endpoints/endpoint-c` returns endpoints that have name that is
	// alphabetically later than the string, so "endpoint-e" is returned but
	// "endpoint-a" is not *
	// `name=projects/my-project/locations/us-central1/namespaces/my-namespace/servi
	// ces/my-service/endpoints/ep-1` returns the endpoint that has an endpoint_id
	// equal to `ep-1` * `metadata.owner!=sd AND metadata.foo=bar` returns
	// endpoints that have `owner` in annotation key but value is not `sd` AND have
	// key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note
	// that endpoint doesn't have a field called "doesnotexist". Since the filter
	// does not match any endpoint, it returns no results For more information
	// about filtering, see API Filtering (https://aip.dev/160).
	EndpointFilter string `json:"endpointFilter,omitempty"`
	// MaxEndpoints: Optional. The maximum number of endpoints to return. Defaults
	// to 25. Maximum is 100. If a value less than one is specified, the Default is
	// used. If a value greater than the Maximum is specified, the Maximum is used.
	MaxEndpoints int64 `json:"maxEndpoints,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndpointFilter") 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. "EndpointFilter") 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:"-"`
}

ResolveServiceRequest: The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.

func (ResolveServiceRequest) MarshalJSON

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

type ResolveServiceResponse

type ResolveServiceResponse struct {
	Service *Service `json:"service,omitempty"`

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

ResolveServiceResponse: The response message for LookupService.ResolveService.

func (ResolveServiceResponse) MarshalJSON

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

type Service

type Service struct {
	// CreateTime: Output only. The timestamp when the service was created.
	CreateTime string `json:"createTime,omitempty"`
	// Endpoints: Output only. Endpoints associated with this service. Returned on
	// LookupService.ResolveService. Control plane clients should use
	// RegistrationService.ListEndpoints.
	Endpoints []*Endpoint `json:"endpoints,omitempty"`
	// Metadata: Optional. Metadata for the service. This data can be consumed by
	// service clients. Restrictions: * The entire metadata dictionary may contain
	// up to 2000 characters, spread accoss all key-value pairs. Metadata that goes
	// beyond this limit are rejected * Valid metadata keys have two segments: an
	// optional prefix and name, separated by a slash (/). The name segment is
	// required and must be 63 characters or less, beginning and ending with an
	// alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots
	// (.), and alphanumerics between. The prefix is optional. If specified, the
	// prefix must be a DNS subdomain: a series of DNS labels separated by dots
	// (.), not longer than 253 characters in total, followed by a slash (/).
	// Metadata that fails to meet these requirements are rejected Note: This field
	// is equivalent to the `annotations` field in the v1 API. They have the same
	// syntax and read/write to the same location in Service Directory.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Name: Immutable. The resource name for the service in the format
	// `projects/*/locations/*/namespaces/*/services/*`.
	Name string `json:"name,omitempty"`
	// Uid: Output only. A globally unique identifier (in UUID4 format) for this
	// service.
	Uid string `json:"uid,omitempty"`
	// UpdateTime: Output only. The timestamp when the service was last updated.
	// Note: endpoints being created/deleted/updated within the service are not
	// considered service updates for the purpose of this timestamp.
	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:"-"`
}

Service: An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

func (Service) MarshalJSON

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

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

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

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

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

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

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

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

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

Jump to

Keyboard shortcuts

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