iam

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package iam provides access to the Identity and Access Management (IAM) API.

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

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/iam/v2"
...
ctx := context.Background()
iamService, err := iam.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: 

iamService, err := iam.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, ...)
iamService, err := iam.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 GoogleCloudCommonOperationMetadata 

type GoogleCloudCommonOperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`

	// CancelRequested: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have been
	// cancelled successfully have Operation.error value with a
	// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
	CancelRequested bool `json:"cancelRequested,omitempty"`

	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`

	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`

	// StatusDetail: Output only. Human-readable status of the operation, if
	// any.
	StatusDetail string `json:"statusDetail,omitempty"`

	// Target: Output only. Server-defined resource path for the target of
	// the operation.
	Target string `json:"target,omitempty"`

	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiVersion") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*GoogleCloudCommonOperationMetadata) MarshalJSON 

func (s *GoogleCloudCommonOperationMetadata) MarshalJSON() ([]byte, error)

type GoogleIamAdminV1AuditData 

type GoogleIamAdminV1AuditData struct {
	// PermissionDelta: The permission_delta when when creating or updating
	// a Role.
	PermissionDelta *GoogleIamAdminV1AuditDataPermissionDelta `json:"permissionDelta,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PermissionDelta") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PermissionDelta") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleIamAdminV1AuditData: Audit log information specific to Cloud IAM admin APIs. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.

func (*GoogleIamAdminV1AuditData) MarshalJSON 

func (s *GoogleIamAdminV1AuditData) MarshalJSON() ([]byte, error)

type GoogleIamAdminV1AuditDataPermissionDelta 

type GoogleIamAdminV1AuditDataPermissionDelta struct {
	// AddedPermissions: Added permissions.
	AddedPermissions []string `json:"addedPermissions,omitempty"`

	// RemovedPermissions: Removed permissions.
	RemovedPermissions []string `json:"removedPermissions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AddedPermissions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AddedPermissions") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleIamAdminV1AuditDataPermissionDelta: A PermissionDelta message to record the added_permissions and removed_permissions inside a role.

func (*GoogleIamAdminV1AuditDataPermissionDelta) MarshalJSON 

func (s *GoogleIamAdminV1AuditDataPermissionDelta) MarshalJSON() ([]byte, error)

type GoogleIamV1BindingDelta 

type GoogleIamV1BindingDelta struct {
	// Action: The action that was performed on a Binding. Required
	//
	// Possible values:
	//   "ACTION_UNSPECIFIED" - Unspecified.
	//   "ADD" - Addition of a Binding.
	//   "REMOVE" - Removal of a Binding.
	Action string `json:"action,omitempty"`

	// Condition: The condition that is associated with this binding.
	Condition *GoogleTypeExpr `json:"condition,omitempty"`

	// Member: A single identity requesting access for a Google Cloud
	// resource. Follows the same format of Binding.members. Required
	Member string `json:"member,omitempty"`

	// Role: Role that is assigned to `members`. For example,
	// `roles/viewer`, `roles/editor`, or `roles/owner`. Required
	Role string `json:"role,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Action") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV1BindingDelta: One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.

func (*GoogleIamV1BindingDelta) MarshalJSON 

func (s *GoogleIamV1BindingDelta) MarshalJSON() ([]byte, error)

type GoogleIamV1LoggingAuditData 

type GoogleIamV1LoggingAuditData struct {
	// PolicyDelta: Policy delta between the original policy and the newly
	// set policy.
	PolicyDelta *GoogleIamV1PolicyDelta `json:"policyDelta,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PolicyDelta") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PolicyDelta") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV1LoggingAuditData: Audit log information specific to Cloud IAM. This message is serialized as an `Any` type in the `ServiceData` message of an `AuditLog` message.

func (*GoogleIamV1LoggingAuditData) MarshalJSON 

func (s *GoogleIamV1LoggingAuditData) MarshalJSON() ([]byte, error)

type GoogleIamV1PolicyDelta 

type GoogleIamV1PolicyDelta struct {
	// BindingDeltas: The delta for Bindings between two policies.
	BindingDeltas []*GoogleIamV1BindingDelta `json:"bindingDeltas,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BindingDeltas") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BindingDeltas") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV1PolicyDelta: The difference delta between two policies.

func (*GoogleIamV1PolicyDelta) MarshalJSON 

func (s *GoogleIamV1PolicyDelta) MarshalJSON() ([]byte, error)

type GoogleIamV1betaWorkloadIdentityPoolOperationMetadata 

type GoogleIamV1betaWorkloadIdentityPoolOperationMetadata struct {
}

GoogleIamV1betaWorkloadIdentityPoolOperationMetadata: Metadata for long-running WorkloadIdentityPool operations.

type GoogleIamV2DenyRule 

type GoogleIamV2DenyRule struct {
	// DenialCondition: The condition that determines whether this deny rule
	// applies to a request. If the condition expression evaluates to
	// `true`, then the deny rule is applied; otherwise, the deny rule is
	// not applied. Each deny rule is evaluated independently. If this deny
	// rule does not apply to a request, other deny rules might still apply.
	// The condition can use CEL functions that evaluate resource tags
	// (https://cloud.google.com/iam/help/conditions/resource-tags). Other
	// functions and operators are not supported.
	DenialCondition *GoogleTypeExpr `json:"denialCondition,omitempty"`

	// DeniedPermissions: The permissions that are explicitly denied by this
	// rule. Each permission uses the format
	// `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the
	// fully qualified domain name for the service. For example,
	// `iam.googleapis.com/roles.list`.
	DeniedPermissions []string `json:"deniedPermissions,omitempty"`

	// DeniedPrincipals: The identities that are prevented from using one or
	// more permissions on Google Cloud resources. This field can contain
	// the following values: * `principalSet://goog/public:all`: A special
	// identifier that represents any principal that is on the internet,
	// even if they do not have a Google Account or are not logged in. *
	// `principal://goog/subject/{email_id}`: A specific Google Account.
	// Includes Gmail, Cloud Identity, and Google Workspace user accounts.
	// For example, `principal://goog/subject/alice@example.com`. *
	// `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific
	// Google Account that was deleted recently. For example,
	// `deleted:principal://goog/subject/alice@example.com?uid=1234567890`.
	// If the Google Account is recovered, this identifier reverts to the
	// standard identifier for a Google Account. *
	// `principalSet://goog/group/{group_id}`: A Google group. For example,
	// `principalSet://goog/group/admins@example.com`. *
	// `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google
	// group that was deleted recently. For example,
	// `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`.
	//  If the Google group is restored, this identifier reverts to the
	// standard identifier for a Google group. *
	// `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_ac
	// count_id}`: A Google Cloud service account. For example,
	// `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-
	// account@iam.gserviceaccount.com`. *
	// `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{se
	// rvice_account_id}?uid={uid}`: A Google Cloud service account that was
	// deleted recently. For example,
	// `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-
	// service-account@iam.gserviceaccount.com?uid=1234567890`. If the
	// service account is undeleted, this identifier reverts to the standard
	// identifier for a service account. *
	// `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of
	// the principals associated with the specified Google Workspace or
	// Cloud Identity customer ID. For example,
	// `principalSet://goog/cloudIdentityCustomerId/C01Abc35`.
	DeniedPrincipals []string `json:"deniedPrincipals,omitempty"`

	// ExceptionPermissions: Specifies the permissions that this rule
	// excludes from the set of denied permissions given by
	// `denied_permissions`. If a permission appears in `denied_permissions`
	// _and_ in `exception_permissions` then it will _not_ be denied. The
	// excluded permissions can be specified using the same syntax as
	// `denied_permissions`.
	ExceptionPermissions []string `json:"exceptionPermissions,omitempty"`

	// ExceptionPrincipals: The identities that are excluded from the deny
	// rule, even if they are listed in the `denied_principals`. For
	// example, you could add a Google group to the `denied_principals`,
	// then exclude specific users who belong to that group. This field can
	// contain the same values as the `denied_principals` field, excluding
	// `principalSet://goog/public:all`, which represents all users on the
	// internet.
	ExceptionPrincipals []string `json:"exceptionPrincipals,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DenialCondition") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DenialCondition") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleIamV2DenyRule: A deny rule in an IAM deny policy.

func (*GoogleIamV2DenyRule) MarshalJSON 

func (s *GoogleIamV2DenyRule) MarshalJSON() ([]byte, error)

type GoogleIamV2ListPoliciesResponse 

type GoogleIamV2ListPoliciesResponse struct {
	// NextPageToken: A page token that you can use in a ListPoliciesRequest
	// to retrieve the next page. If this field is omitted, there are no
	// additional pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Policies: Metadata for the policies that are attached to the
	// resource.
	Policies []*GoogleIamV2Policy `json:"policies,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV2ListPoliciesResponse: Response message for `ListPolicies`.

func (*GoogleIamV2ListPoliciesResponse) MarshalJSON 

func (s *GoogleIamV2ListPoliciesResponse) MarshalJSON() ([]byte, error)

type GoogleIamV2Policy 

type GoogleIamV2Policy struct {
	// Annotations: A key-value map to store arbitrary metadata for the
	// `Policy`. Keys can be up to 63 characters. Values can be up to 255
	// characters.
	Annotations map[string]string `json:"annotations,omitempty"`

	// CreateTime: Output only. The time when the `Policy` was created.
	CreateTime string `json:"createTime,omitempty"`

	// DeleteTime: Output only. The time when the `Policy` was deleted.
	// Empty if the policy is not deleted.
	DeleteTime string `json:"deleteTime,omitempty"`

	// DisplayName: A user-specified description of the `Policy`. This value
	// can be up to 63 characters.
	DisplayName string `json:"displayName,omitempty"`

	// Etag: An opaque tag that identifies the current version of the
	// `Policy`. IAM uses this value to help manage concurrent updates, so
	// they do not cause one update to be overwritten by another. If this
	// field is present in a CreatePolicyRequest, the value is ignored.
	Etag string `json:"etag,omitempty"`

	// Kind: Output only. The kind of the `Policy`. Always contains the
	// value `DenyPolicy`.
	Kind string `json:"kind,omitempty"`

	// Name: Immutable. The resource name of the `Policy`, which must be
	// unique. Format:
	// `policies/{attachment_point}/denypolicies/{policy_id}` The attachment
	// point is identified by its URL-encoded full resource name, which
	// means that the forward-slash character, `/`, must be written as
	// `%2F`. For example,
	// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/
	// denypolicies/my-deny-policy`. For organizations and folders, use the
	// numeric ID in the full resource name. For projects, requests can use
	// the alphanumeric or the numeric ID. Responses always contain the
	// numeric ID.
	Name string `json:"name,omitempty"`

	// Rules: A list of rules that specify the behavior of the `Policy`. All
	// of the rules should be of the `kind` specified in the `Policy`.
	Rules []*GoogleIamV2PolicyRule `json:"rules,omitempty"`

	// Uid: Immutable. The globally unique ID of the `Policy`. Assigned
	// automatically when the `Policy` is created.
	Uid string `json:"uid,omitempty"`

	// UpdateTime: Output only. The time when the `Policy` 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. "Annotations") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Annotations") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV2Policy: Data for an IAM policy.

func (*GoogleIamV2Policy) MarshalJSON 

func (s *GoogleIamV2Policy) MarshalJSON() ([]byte, error)

type GoogleIamV2PolicyOperationMetadata 

type GoogleIamV2PolicyOperationMetadata struct {
	// CreateTime: Timestamp when the `google.longrunning.Operation` was
	// created.
	CreateTime string `json:"createTime,omitempty"`

	// 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV2PolicyOperationMetadata: Metadata for long-running `Policy` operations.

func (*GoogleIamV2PolicyOperationMetadata) MarshalJSON 

func (s *GoogleIamV2PolicyOperationMetadata) MarshalJSON() ([]byte, error)

type GoogleIamV2PolicyRule 

type GoogleIamV2PolicyRule struct {
	// DenyRule: A rule for a deny policy.
	DenyRule *GoogleIamV2DenyRule `json:"denyRule,omitempty"`

	// Description: A user-specified description of the rule. This value can
	// be up to 256 characters.
	Description string `json:"description,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DenyRule") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DenyRule") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleIamV2PolicyRule: A single rule in a `Policy`.

func (*GoogleIamV2PolicyRule) MarshalJSON 

func (s *GoogleIamV2PolicyRule) MarshalJSON() ([]byte, error)

type GoogleLongrunningOperation 

type GoogleLongrunningOperation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *GoogleRpcStatus `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal, successful response of the operation. If the
	// original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*GoogleLongrunningOperation) MarshalJSON 

func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)

type GoogleRpcStatus 

type GoogleRpcStatus struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*GoogleRpcStatus) MarshalJSON 

func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)

type GoogleTypeExpr 

type GoogleTypeExpr 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleTypeExpr: 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 (*GoogleTypeExpr) MarshalJSON 

func (s *GoogleTypeExpr) MarshalJSON() ([]byte, error)

type PoliciesCreatePolicyCall 

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

func (*PoliciesCreatePolicyCall) Context 

func (c *PoliciesCreatePolicyCall) Context(ctx context.Context) *PoliciesCreatePolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesCreatePolicyCall) Do 

func (c *PoliciesCreatePolicyCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "iam.policies.createPolicy" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*PoliciesCreatePolicyCall) Fields 

func (c *PoliciesCreatePolicyCall) Fields(s ...googleapi.Field) *PoliciesCreatePolicyCall

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

func (*PoliciesCreatePolicyCall) Header 

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

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

func (*PoliciesCreatePolicyCall) PolicyId 

func (c *PoliciesCreatePolicyCall) PolicyId(policyId string) *PoliciesCreatePolicyCall

PolicyId sets the optional parameter "policyId": The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (`-`) and periods (`.`). The first character must be a lowercase letter.

type PoliciesDeleteCall 

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

func (*PoliciesDeleteCall) Context 

func (c *PoliciesDeleteCall) Context(ctx context.Context) *PoliciesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesDeleteCall) Do 

func (c *PoliciesDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "iam.policies.delete" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*PoliciesDeleteCall) Etag 

func (c *PoliciesDeleteCall) Etag(etag string) *PoliciesDeleteCall

Etag sets the optional parameter "etag": The expected `etag` of the policy to delete. If the value does not match the value that is stored in IAM, the request fails with a `409` error code and `ABORTED` status. If you omit this field, the policy is deleted regardless of its current `etag`.

func (*PoliciesDeleteCall) Fields 

func (c *PoliciesDeleteCall) Fields(s ...googleapi.Field) *PoliciesDeleteCall

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

func (*PoliciesDeleteCall) Header 

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

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

type PoliciesGetCall 

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

func (*PoliciesGetCall) Context 

func (c *PoliciesGetCall) Context(ctx context.Context) *PoliciesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesGetCall) Do 

func (c *PoliciesGetCall) Do(opts ...googleapi.CallOption) (*GoogleIamV2Policy, error)

Do executes the "iam.policies.get" call. Exactly one of *GoogleIamV2Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleIamV2Policy.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 (*PoliciesGetCall) Fields 

func (c *PoliciesGetCall) Fields(s ...googleapi.Field) *PoliciesGetCall

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

func (*PoliciesGetCall) Header 

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

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

func (*PoliciesGetCall) IfNoneMatch 

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type PoliciesListPoliciesCall 

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

func (*PoliciesListPoliciesCall) Context 

func (c *PoliciesListPoliciesCall) Context(ctx context.Context) *PoliciesListPoliciesCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesListPoliciesCall) Do 

func (c *PoliciesListPoliciesCall) Do(opts ...googleapi.CallOption) (*GoogleIamV2ListPoliciesResponse, error)

Do executes the "iam.policies.listPolicies" call. Exactly one of *GoogleIamV2ListPoliciesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleIamV2ListPoliciesResponse.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 (*PoliciesListPoliciesCall) Fields 

func (c *PoliciesListPoliciesCall) Fields(s ...googleapi.Field) *PoliciesListPoliciesCall

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

func (*PoliciesListPoliciesCall) Header 

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

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

func (*PoliciesListPoliciesCall) IfNoneMatch 

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*PoliciesListPoliciesCall) PageSize 

func (c *PoliciesListPoliciesCall) PageSize(pageSize int64) *PoliciesListPoliciesCall

PageSize sets the optional parameter "pageSize": The maximum number of policies to return. IAM ignores this value and uses the value 1000.

func (*PoliciesListPoliciesCall) PageToken 

func (c *PoliciesListPoliciesCall) PageToken(pageToken string) *PoliciesListPoliciesCall

PageToken sets the optional parameter "pageToken": A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

func (*PoliciesListPoliciesCall) Pages 

func (c *PoliciesListPoliciesCall) Pages(ctx context.Context, f func(*GoogleIamV2ListPoliciesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type PoliciesOperationsGetCall 

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

func (*PoliciesOperationsGetCall) Context 

func (c *PoliciesOperationsGetCall) Context(ctx context.Context) *PoliciesOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesOperationsGetCall) Do 

func (c *PoliciesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "iam.policies.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*PoliciesOperationsGetCall) Fields 

func (c *PoliciesOperationsGetCall) Fields(s ...googleapi.Field) *PoliciesOperationsGetCall

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

func (*PoliciesOperationsGetCall) Header 

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

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

func (*PoliciesOperationsGetCall) IfNoneMatch 

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

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type PoliciesOperationsService 

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

func NewPoliciesOperationsService 

func NewPoliciesOperationsService(s *Service) *PoliciesOperationsService

func (*PoliciesOperationsService) Get 

func (r *PoliciesOperationsService) Get(name string) *PoliciesOperationsGetCall

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

- name: The name of the operation resource.

type PoliciesService 

type PoliciesService struct {
	Operations *PoliciesOperationsService
	// contains filtered or unexported fields
}

func NewPoliciesService 

func NewPoliciesService(s *Service) *PoliciesService

func (*PoliciesService) CreatePolicy 

func (r *PoliciesService) CreatePolicy(parent string, googleiamv2policy *GoogleIamV2Policy) *PoliciesCreatePolicyCall

CreatePolicy: Creates a policy.

  • parent: The resource that the policy is attached to, along with the kind of policy to create. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-projec t/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

func (*PoliciesService) Delete 

func (r *PoliciesService) Delete(name string) *PoliciesDeleteCall

Delete: Deletes a policy. This action is permanent.

  • name: The resource name of the policy to delete. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-projec t/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

func (*PoliciesService) Get 

func (r *PoliciesService) Get(name string) *PoliciesGetCall

Get: Gets a policy.

  • name: The resource name of the policy to retrieve. Format: `policies/{attachment_point}/denypolicies/{policy_id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-projec t/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

func (*PoliciesService) ListPolicies 

func (r *PoliciesService) ListPolicies(parent string) *PoliciesListPoliciesCall

ListPolicies: Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.

  • parent: The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-projec t/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

func (*PoliciesService) Update 

func (r *PoliciesService) Update(name string, googleiamv2policy *GoogleIamV2Policy) *PoliciesUpdateCall

Update: Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop: 1. Use GetPolicy to read the current version of the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to write the updated policy. This pattern helps prevent conflicts between concurrent updates.

  • name: Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-projec t/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

type PoliciesUpdateCall 

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

func (*PoliciesUpdateCall) Context 

func (c *PoliciesUpdateCall) Context(ctx context.Context) *PoliciesUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PoliciesUpdateCall) Do 

func (c *PoliciesUpdateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "iam.policies.update" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.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 (*PoliciesUpdateCall) Fields 

func (c *PoliciesUpdateCall) Fields(s ...googleapi.Field) *PoliciesUpdateCall

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

func (*PoliciesUpdateCall) Header 

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

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

type Service 

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

	Policies *PoliciesService
	// contains filtered or unexported fields
}

func New deprecated 

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

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

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.