Documentation ¶
Overview ¶
Package cloudresourcemanager provides access to the Cloud Resource Manager API.
For product documentation, see: https://cloud.google.com/resource-manager
Creating a client ¶
Usage example:
import "google.golang.org/api/cloudresourcemanager/v1beta1" ... ctx := context.Background() cloudresourcemanagerService, err := cloudresourcemanager.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 ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx, option.WithScopes(cloudresourcemanager.CloudPlatformReadOnlyScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) cloudresourcemanagerService, err := cloudresourcemanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type Ancestor
- type AuditConfig
- type AuditLogConfig
- type Binding
- type Empty
- type Expr
- type FolderOperation
- type FolderOperationError
- type GetAncestryRequest
- type GetAncestryResponse
- type GetIamPolicyRequest
- type GetPolicyOptions
- type ListOrganizationsResponse
- type ListProjectsResponse
- type Organization
- type OrganizationOwner
- type OrganizationsGetCall
- func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall
- func (c *OrganizationsGetCall) Do(opts ...googleapi.CallOption) (*Organization, error)
- func (c *OrganizationsGetCall) Fields(s ...googleapi.Field) *OrganizationsGetCall
- func (c *OrganizationsGetCall) Header() http.Header
- func (c *OrganizationsGetCall) IfNoneMatch(entityTag string) *OrganizationsGetCall
- func (c *OrganizationsGetCall) OrganizationId(organizationId string) *OrganizationsGetCall
- type OrganizationsGetIamPolicyCall
- func (c *OrganizationsGetIamPolicyCall) Context(ctx context.Context) *OrganizationsGetIamPolicyCall
- func (c *OrganizationsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *OrganizationsGetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsGetIamPolicyCall
- func (c *OrganizationsGetIamPolicyCall) Header() http.Header
- type OrganizationsListCall
- func (c *OrganizationsListCall) Context(ctx context.Context) *OrganizationsListCall
- func (c *OrganizationsListCall) Do(opts ...googleapi.CallOption) (*ListOrganizationsResponse, error)
- func (c *OrganizationsListCall) Fields(s ...googleapi.Field) *OrganizationsListCall
- func (c *OrganizationsListCall) Filter(filter string) *OrganizationsListCall
- func (c *OrganizationsListCall) Header() http.Header
- func (c *OrganizationsListCall) IfNoneMatch(entityTag string) *OrganizationsListCall
- func (c *OrganizationsListCall) PageSize(pageSize int64) *OrganizationsListCall
- func (c *OrganizationsListCall) PageToken(pageToken string) *OrganizationsListCall
- func (c *OrganizationsListCall) Pages(ctx context.Context, f func(*ListOrganizationsResponse) error) error
- type OrganizationsService
- func (r *OrganizationsService) Get(name string) *OrganizationsGetCall
- func (r *OrganizationsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *OrganizationsGetIamPolicyCall
- func (r *OrganizationsService) List() *OrganizationsListCall
- func (r *OrganizationsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *OrganizationsSetIamPolicyCall
- func (r *OrganizationsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall
- func (r *OrganizationsService) Update(name string, organization *Organization) *OrganizationsUpdateCall
- type OrganizationsSetIamPolicyCall
- func (c *OrganizationsSetIamPolicyCall) Context(ctx context.Context) *OrganizationsSetIamPolicyCall
- func (c *OrganizationsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *OrganizationsSetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsSetIamPolicyCall
- func (c *OrganizationsSetIamPolicyCall) Header() http.Header
- type OrganizationsTestIamPermissionsCall
- func (c *OrganizationsTestIamPermissionsCall) Context(ctx context.Context) *OrganizationsTestIamPermissionsCall
- func (c *OrganizationsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *OrganizationsTestIamPermissionsCall) Fields(s ...googleapi.Field) *OrganizationsTestIamPermissionsCall
- func (c *OrganizationsTestIamPermissionsCall) Header() http.Header
- type OrganizationsUpdateCall
- func (c *OrganizationsUpdateCall) Context(ctx context.Context) *OrganizationsUpdateCall
- func (c *OrganizationsUpdateCall) Do(opts ...googleapi.CallOption) (*Organization, error)
- func (c *OrganizationsUpdateCall) Fields(s ...googleapi.Field) *OrganizationsUpdateCall
- func (c *OrganizationsUpdateCall) Header() http.Header
- type Policy
- type Project
- type ProjectCreationStatus
- type ProjectsCreateCall
- func (c *ProjectsCreateCall) Context(ctx context.Context) *ProjectsCreateCall
- func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Project, error)
- func (c *ProjectsCreateCall) Fields(s ...googleapi.Field) *ProjectsCreateCall
- func (c *ProjectsCreateCall) Header() http.Header
- func (c *ProjectsCreateCall) UseLegacyStack(useLegacyStack bool) *ProjectsCreateCall
- type ProjectsDeleteCall
- type ProjectsGetAncestryCall
- func (c *ProjectsGetAncestryCall) Context(ctx context.Context) *ProjectsGetAncestryCall
- func (c *ProjectsGetAncestryCall) Do(opts ...googleapi.CallOption) (*GetAncestryResponse, error)
- func (c *ProjectsGetAncestryCall) Fields(s ...googleapi.Field) *ProjectsGetAncestryCall
- func (c *ProjectsGetAncestryCall) Header() http.Header
- type ProjectsGetCall
- func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall
- func (c *ProjectsGetCall) Do(opts ...googleapi.CallOption) (*Project, error)
- func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall
- func (c *ProjectsGetCall) Header() http.Header
- func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall
- type ProjectsGetIamPolicyCall
- func (c *ProjectsGetIamPolicyCall) Context(ctx context.Context) *ProjectsGetIamPolicyCall
- func (c *ProjectsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsGetIamPolicyCall
- func (c *ProjectsGetIamPolicyCall) Header() http.Header
- type ProjectsListCall
- func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall
- func (c *ProjectsListCall) Do(opts ...googleapi.CallOption) (*ListProjectsResponse, error)
- func (c *ProjectsListCall) Fields(s ...googleapi.Field) *ProjectsListCall
- func (c *ProjectsListCall) Filter(filter string) *ProjectsListCall
- func (c *ProjectsListCall) Header() http.Header
- func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall
- func (c *ProjectsListCall) PageSize(pageSize int64) *ProjectsListCall
- func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall
- func (c *ProjectsListCall) Pages(ctx context.Context, f func(*ListProjectsResponse) error) error
- type ProjectsService
- func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall
- func (r *ProjectsService) Delete(projectId string) *ProjectsDeleteCall
- func (r *ProjectsService) Get(projectId string) *ProjectsGetCall
- func (r *ProjectsService) GetAncestry(projectId string, getancestryrequest *GetAncestryRequest) *ProjectsGetAncestryCall
- func (r *ProjectsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall
- func (r *ProjectsService) List() *ProjectsListCall
- func (r *ProjectsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSetIamPolicyCall
- func (r *ProjectsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall
- func (r *ProjectsService) Undelete(projectId string, undeleteprojectrequest *UndeleteProjectRequest) *ProjectsUndeleteCall
- func (r *ProjectsService) Update(projectId string, project *Project) *ProjectsUpdateCall
- type ProjectsSetIamPolicyCall
- func (c *ProjectsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSetIamPolicyCall
- func (c *ProjectsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSetIamPolicyCall
- func (c *ProjectsSetIamPolicyCall) Header() http.Header
- type ProjectsTestIamPermissionsCall
- func (c *ProjectsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsTestIamPermissionsCall
- func (c *ProjectsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsTestIamPermissionsCall
- func (c *ProjectsTestIamPermissionsCall) Header() http.Header
- type ProjectsUndeleteCall
- type ProjectsUpdateCall
- type ResourceId
- type Service
- type SetIamPolicyRequest
- type TestIamPermissionsRequest
- type TestIamPermissionsResponse
- type UndeleteProjectRequest
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View your data across Google Cloud Platform services CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Ancestor ¶
type Ancestor struct { // ResourceId: Resource id of the ancestor. ResourceId *ResourceId `json:"resourceId,omitempty"` // ForceSendFields is a list of field names (e.g. "ResourceId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ResourceId") 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:"-"` }
Ancestor: Identifying information for a single ancestor of a project.
func (*Ancestor) MarshalJSON ¶
type AuditConfig ¶
type AuditConfig struct { // AuditLogConfigs: The configuration for logging of each type of // permission. AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"` // Service: Specifies a service that will be enabled for audit // logging. // For example, `storage.googleapis.com`, // `cloudsql.googleapis.com`. // `allServices` is a special value that covers all services. Service string `json:"service,omitempty"` // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuditLogConfigs") 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:"-"` }
AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
Example Policy with multiple AuditConfigs:
{ "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
func (*AuditConfig) MarshalJSON ¶
func (s *AuditConfig) MarshalJSON() ([]byte, error)
type AuditLogConfig ¶
type AuditLogConfig struct { // ExemptedMembers: Specifies the identities that do not cause logging // for this type of // permission. // Follows the same format of Binding.members. ExemptedMembers []string `json:"exemptedMembers,omitempty"` // LogType: The log type that this config enables. // // Possible values: // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this. // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy // "DATA_WRITE" - Data writes. Example: CloudSQL Users create // "DATA_READ" - Data reads. Example: CloudSQL Users list LogType string `json:"logType,omitempty"` // ForceSendFields is a list of field names (e.g. "ExemptedMembers") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExemptedMembers") 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:"-"` }
AuditLogConfig: Provides the configuration for logging a type of permissions. Example:
{ "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
func (*AuditLogConfig) MarshalJSON ¶
func (s *AuditLogConfig) MarshalJSON() ([]byte, error)
type Binding ¶
type Binding struct { // Condition: The condition that is associated with this binding. // NOTE: An unsatisfied condition will not allow user access via // current // binding. Different bindings, including their conditions, are // examined // independently. Condition *Expr `json:"condition,omitempty"` // Members: Specifies the identities requesting access for a Cloud // Platform 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. // // * `user:{emailid}`: An email address that represents a specific // Google // account. For example, `alice@example.com` . // // // * `serviceAccount:{emailid}`: An email address that represents a // service // account. For example, // `my-other-app@appspot.gserviceaccount.com`. // // * `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`. // // Members []string `json:"members,omitempty"` // Role: Role that is assigned to `members`. // For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 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 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. "Condition") 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:"-"` }
Binding: Associates `members` with a `role`.
func (*Binding) MarshalJSON ¶
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);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type Expr ¶
type Expr struct { // Description: An 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. // // The application context of the containing message determines // which // well-known feature set of CEL is supported. Expression string `json:"expression,omitempty"` // Location: An 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: An 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 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:"-"` }
Expr: Represents an expression text. Example:
title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
func (*Expr) MarshalJSON ¶
type FolderOperation ¶
type FolderOperation struct { // DestinationParent: The resource name of the folder or organization we // are either creating // the folder under or moving the folder to. DestinationParent string `json:"destinationParent,omitempty"` // DisplayName: The display name of the folder. DisplayName string `json:"displayName,omitempty"` // OperationType: The type of this operation. // // Possible values: // "OPERATION_TYPE_UNSPECIFIED" - Operation type not specified. // "CREATE" - A create folder operation. // "MOVE" - A move folder operation. OperationType string `json:"operationType,omitempty"` // SourceParent: The resource name of the folder's parent. // Only applicable when the operation_type is MOVE. SourceParent string `json:"sourceParent,omitempty"` // ForceSendFields is a list of field names (e.g. "DestinationParent") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DestinationParent") 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:"-"` }
FolderOperation: Metadata describing a long running folder operation
func (*FolderOperation) MarshalJSON ¶
func (s *FolderOperation) MarshalJSON() ([]byte, error)
type FolderOperationError ¶
type FolderOperationError struct { // ErrorMessageId: The type of operation error experienced. // // Possible values: // "ERROR_TYPE_UNSPECIFIED" - The error type was unrecognized or // unspecified. // "ACTIVE_FOLDER_HEIGHT_VIOLATION" - The attempted action would // violate the max folder depth constraint. // "MAX_CHILD_FOLDERS_VIOLATION" - The attempted action would violate // the max child folders constraint. // "FOLDER_NAME_UNIQUENESS_VIOLATION" - The attempted action would // violate the locally-unique folder // display_name constraint. // "RESOURCE_DELETED_VIOLATION" - The resource being moved has been // deleted. // "PARENT_DELETED_VIOLATION" - The resource a folder was being added // to has been deleted. // "CYCLE_INTRODUCED_VIOLATION" - The attempted action would introduce // cycle in resource path. // "FOLDER_BEING_MOVED_VIOLATION" - The attempted action would move a // folder that is already being moved. // "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION" - The folder the caller is // trying to delete contains active resources. // "DELETED_FOLDER_HEIGHT_VIOLATION" - The attempted action would // violate the max deleted folder depth // constraint. ErrorMessageId string `json:"errorMessageId,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorMessageId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ErrorMessageId") 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:"-"` }
FolderOperationError: A classification of the Folder Operation error.
func (*FolderOperationError) MarshalJSON ¶
func (s *FolderOperationError) MarshalJSON() ([]byte, error)
type GetAncestryRequest ¶
type GetAncestryRequest struct { }
GetAncestryRequest: The request sent to the GetAncestry method.
type GetAncestryResponse ¶
type GetAncestryResponse struct { // Ancestor: Ancestors are ordered from bottom to top of the resource // hierarchy. The // first ancestor is the project itself, followed by the project's // parent, // etc. Ancestor []*Ancestor `json:"ancestor,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Ancestor") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Ancestor") 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:"-"` }
GetAncestryResponse: Response from the GetAncestry method.
func (*GetAncestryResponse) MarshalJSON ¶
func (s *GetAncestryResponse) MarshalJSON() ([]byte, error)
type GetIamPolicyRequest ¶
type GetIamPolicyRequest struct { // Options: OPTIONAL: A `GetPolicyOptions` object for specifying options // to // `GetIamPolicy`. This field is only used by Cloud IAM. 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 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. "Options") 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:"-"` }
GetIamPolicyRequest: Request message for `GetIamPolicy` method.
func (*GetIamPolicyRequest) MarshalJSON ¶ added in v0.8.0
func (s *GetIamPolicyRequest) MarshalJSON() ([]byte, error)
type GetPolicyOptions ¶ added in v0.8.0
type GetPolicyOptions struct { // RequestedPolicyVersion: Optional. The policy format version to be // returned. // // Valid values are 0, 1, and 3. Requests specifying an invalid value // will be // rejected. // // Requests for policies with any conditional bindings must specify // version 3. // Policies without any conditional bindings may specify any valid value // or // leave the field unset. 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 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. "RequestedPolicyVersion") // 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:"-"` }
GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.
func (*GetPolicyOptions) MarshalJSON ¶ added in v0.8.0
func (s *GetPolicyOptions) MarshalJSON() ([]byte, error)
type ListOrganizationsResponse ¶
type ListOrganizationsResponse struct { // NextPageToken: A pagination token to be used to retrieve the next // page of results. If the // result is too large to fit within the page size specified in the // request, // this field will be set with a token that can be used to fetch the // next page // of results. If this field is empty, it indicates that this // response // contains the last page of results. NextPageToken string `json:"nextPageToken,omitempty"` // Organizations: The list of Organizations that matched the list query, // possibly paginated. Organizations []*Organization `json:"organizations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOrganizationsResponse: The response returned from the `ListOrganizations` method.
func (*ListOrganizationsResponse) MarshalJSON ¶
func (s *ListOrganizationsResponse) MarshalJSON() ([]byte, error)
type ListProjectsResponse ¶
type ListProjectsResponse struct { // NextPageToken: Pagination token. // // If the result set is too large to fit in a single response, this // token // is returned. It encodes the position of the current result // cursor. // Feeding this value into a new list request with the `page_token` // parameter // gives the next page of the results. // // When `next_page_token` is not filled in, there is no next page // and // the list returned is the last page in the result set. // // Pagination tokens have a limited lifetime. NextPageToken string `json:"nextPageToken,omitempty"` // Projects: The list of Projects that matched the list filter. This // list can // be paginated. Projects []*Project `json:"projects,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListProjectsResponse: A page of the response received from the ListProjects method.
A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
func (*ListProjectsResponse) MarshalJSON ¶
func (s *ListProjectsResponse) MarshalJSON() ([]byte, error)
type Organization ¶
type Organization struct { // CreationTime: Timestamp when the Organization was created. Assigned // by the server. CreationTime string `json:"creationTime,omitempty"` // DisplayName: A human-readable string that refers to the Organization // in the // GCP Console UI. This string is set by the server and cannot // be // changed. The string will be set to the primary domain (for // example, // "google.com") of the G Suite customer that owns the organization. DisplayName string `json:"displayName,omitempty"` // LifecycleState: The organization's current lifecycle state. Assigned // by the server. // // Possible values: // "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only // useful for distinguishing unset values. // "ACTIVE" - The normal and active state. // "DELETE_REQUESTED" - The organization has been marked for deletion // by the user. LifecycleState string `json:"lifecycleState,omitempty"` // Name: Output only. The resource name of the organization. This is // the // organization's relative path in the API. Its format // is // "organizations/[organization_id]". For example, "organizations/1234". Name string `json:"name,omitempty"` // OrganizationId: An immutable id for the Organization that is assigned // on creation. This // should be omitted when creating a new Organization. // This field is read-only. OrganizationId string `json:"organizationId,omitempty"` // Owner: The owner of this Organization. The owner should be specified // on // creation. Once set, it cannot be changed. // This field is required. Owner *OrganizationOwner `json:"owner,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "CreationTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CreationTime") 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:"-"` }
Organization: The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
func (*Organization) MarshalJSON ¶
func (s *Organization) MarshalJSON() ([]byte, error)
type OrganizationOwner ¶
type OrganizationOwner struct { // DirectoryCustomerId: The G Suite customer id used in the Directory // API. DirectoryCustomerId string `json:"directoryCustomerId,omitempty"` // ForceSendFields is a list of field names (e.g. "DirectoryCustomerId") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DirectoryCustomerId") 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:"-"` }
OrganizationOwner: The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted.
func (*OrganizationOwner) MarshalJSON ¶
func (s *OrganizationOwner) MarshalJSON() ([]byte, error)
type OrganizationsGetCall ¶
type OrganizationsGetCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsGetCall) Context ¶
func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall
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 (*OrganizationsGetCall) Do ¶
func (c *OrganizationsGetCall) Do(opts ...googleapi.CallOption) (*Organization, error)
Do executes the "cloudresourcemanager.organizations.get" call. Exactly one of *Organization or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Organization.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 (*OrganizationsGetCall) Fields ¶
func (c *OrganizationsGetCall) Fields(s ...googleapi.Field) *OrganizationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsGetCall) Header ¶
func (c *OrganizationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OrganizationsGetCall) IfNoneMatch ¶
func (c *OrganizationsGetCall) IfNoneMatch(entityTag string) *OrganizationsGetCall
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 (*OrganizationsGetCall) OrganizationId ¶
func (c *OrganizationsGetCall) OrganizationId(organizationId string) *OrganizationsGetCall
OrganizationId sets the optional parameter "organizationId": The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.
type OrganizationsGetIamPolicyCall ¶
type OrganizationsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsGetIamPolicyCall) Context ¶
func (c *OrganizationsGetIamPolicyCall) Context(ctx context.Context) *OrganizationsGetIamPolicyCall
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 (*OrganizationsGetIamPolicyCall) Do ¶
func (c *OrganizationsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "cloudresourcemanager.organizations.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*OrganizationsGetIamPolicyCall) Fields ¶
func (c *OrganizationsGetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsGetIamPolicyCall) Header ¶
func (c *OrganizationsGetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OrganizationsListCall ¶
type OrganizationsListCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsListCall) Context ¶
func (c *OrganizationsListCall) Context(ctx context.Context) *OrganizationsListCall
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 (*OrganizationsListCall) Do ¶
func (c *OrganizationsListCall) Do(opts ...googleapi.CallOption) (*ListOrganizationsResponse, error)
Do executes the "cloudresourcemanager.organizations.list" call. Exactly one of *ListOrganizationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOrganizationsResponse.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 (*OrganizationsListCall) Fields ¶
func (c *OrganizationsListCall) Fields(s ...googleapi.Field) *OrganizationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsListCall) Filter ¶
func (c *OrganizationsListCall) Filter(filter string) *OrganizationsListCall
Filter sets the optional parameter "filter": An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive.
Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example:
* Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`.
This field is optional.
func (*OrganizationsListCall) Header ¶
func (c *OrganizationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OrganizationsListCall) IfNoneMatch ¶
func (c *OrganizationsListCall) IfNoneMatch(entityTag string) *OrganizationsListCall
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 (*OrganizationsListCall) PageSize ¶
func (c *OrganizationsListCall) PageSize(pageSize int64) *OrganizationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of Organizations to return in the response. This field is optional.
func (*OrganizationsListCall) PageToken ¶
func (c *OrganizationsListCall) PageToken(pageToken string) *OrganizationsListCall
PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional.
func (*OrganizationsListCall) Pages ¶
func (c *OrganizationsListCall) Pages(ctx context.Context, f func(*ListOrganizationsResponse) 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 OrganizationsService ¶
type OrganizationsService struct {
// contains filtered or unexported fields
}
func NewOrganizationsService ¶
func NewOrganizationsService(s *Service) *OrganizationsService
func (*OrganizationsService) Get ¶
func (r *OrganizationsService) Get(name string) *OrganizationsGetCall
Get: Fetches an Organization resource identified by the specified resource name.
func (*OrganizationsService) GetIamPolicy ¶
func (r *OrganizationsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *OrganizationsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. "organizations/123".
func (*OrganizationsService) List ¶
func (r *OrganizationsService) List() *OrganizationsListCall
List: Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.
func (*OrganizationsService) SetIamPolicy ¶
func (r *OrganizationsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *OrganizationsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. "organizations/123".
func (*OrganizationsService) TestIamPermissions ¶
func (r *OrganizationsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *OrganizationsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. "organizations/123".
func (*OrganizationsService) Update ¶
func (r *OrganizationsService) Update(name string, organization *Organization) *OrganizationsUpdateCall
Update: Updates an Organization resource identified by the specified resource name.
type OrganizationsSetIamPolicyCall ¶
type OrganizationsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsSetIamPolicyCall) Context ¶
func (c *OrganizationsSetIamPolicyCall) Context(ctx context.Context) *OrganizationsSetIamPolicyCall
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 (*OrganizationsSetIamPolicyCall) Do ¶
func (c *OrganizationsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "cloudresourcemanager.organizations.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*OrganizationsSetIamPolicyCall) Fields ¶
func (c *OrganizationsSetIamPolicyCall) Fields(s ...googleapi.Field) *OrganizationsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsSetIamPolicyCall) Header ¶
func (c *OrganizationsSetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OrganizationsTestIamPermissionsCall ¶
type OrganizationsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsTestIamPermissionsCall) Context ¶
func (c *OrganizationsTestIamPermissionsCall) Context(ctx context.Context) *OrganizationsTestIamPermissionsCall
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 (*OrganizationsTestIamPermissionsCall) Do ¶
func (c *OrganizationsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "cloudresourcemanager.organizations.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 (*OrganizationsTestIamPermissionsCall) Fields ¶
func (c *OrganizationsTestIamPermissionsCall) Fields(s ...googleapi.Field) *OrganizationsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsTestIamPermissionsCall) Header ¶
func (c *OrganizationsTestIamPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OrganizationsUpdateCall ¶
type OrganizationsUpdateCall struct {
// contains filtered or unexported fields
}
func (*OrganizationsUpdateCall) Context ¶
func (c *OrganizationsUpdateCall) Context(ctx context.Context) *OrganizationsUpdateCall
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 (*OrganizationsUpdateCall) Do ¶
func (c *OrganizationsUpdateCall) Do(opts ...googleapi.CallOption) (*Organization, error)
Do executes the "cloudresourcemanager.organizations.update" call. Exactly one of *Organization or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Organization.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 (*OrganizationsUpdateCall) Fields ¶
func (c *OrganizationsUpdateCall) Fields(s ...googleapi.Field) *OrganizationsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OrganizationsUpdateCall) Header ¶
func (c *OrganizationsUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type Policy ¶
type Policy struct { // AuditConfigs: Specifies cloud audit logging configuration for this // policy. AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"` // Bindings: Associates a list of `members` to a `role`. Optionally may // specify a // `condition` that determines when binding is in effect. // `bindings` with no members will result in an error. 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. // // If no `etag` is provided in the call to `setIamPolicy`, then the // existing // policy is overwritten. Due to blind-set semantics of an etag-less // policy, // 'setIamPolicy' will not fail even if the incoming policy version does // not // meet the requirements for modifying the stored policy. Etag string `json:"etag,omitempty"` // Version: Specifies the format of the policy. // // Valid values are 0, 1, and 3. Requests specifying an invalid value // will be // rejected. // // Operations affecting conditional bindings must specify version 3. // This can // be either setting a conditional policy, modifying a conditional // binding, // or removing a binding (conditional or unconditional) from the // stored // conditional policy. // Operations on non-conditional policies may specify any valid value // or // leave the field unset. // // If no etag is provided in the call to `setIamPolicy`, version // compliance // checks against the stored policy is skipped. 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. "AuditConfigs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AuditConfigs") 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:"-"` }
Policy: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
**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')", } } ] }
**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')
For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
func (*Policy) MarshalJSON ¶
type Project ¶
type Project struct { // CreateTime: Creation time. // // Read-only. CreateTime string `json:"createTime,omitempty"` // Labels: The labels associated with this Project. // // Label keys must be between 1 and 63 characters long and must // conform // to the following regular expression: // \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. // // Label values must be between 0 and 63 characters long and must // conform // to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A // label // value can be empty. // // No more than 256 labels can be associated with a given // resource. // // Clients should store labels in a representation such as JSON that // does not // depend on specific characters being disallowed. // // Example: <code>"environment" : "dev"</code> // Read-write. Labels map[string]string `json:"labels,omitempty"` // LifecycleState: The Project lifecycle state. // // Read-only. // // Possible values: // "LIFECYCLE_STATE_UNSPECIFIED" - Unspecified state. This is only // used/useful for distinguishing // unset values. // "ACTIVE" - The normal and active state. // "DELETE_REQUESTED" - The project has been marked for deletion by // the user // (by invoking // DeleteProject) // or by the system (Google Cloud Platform). // This can generally be reversed by invoking UndeleteProject. // "DELETE_IN_PROGRESS" - This lifecycle state is no longer used and // is not returned by the API. LifecycleState string `json:"lifecycleState,omitempty"` // Name: The optional user-assigned display name of the Project. // When present it must be between 4 to 30 characters. // Allowed characters are: lowercase and uppercase letters, // numbers, // hyphen, single-quote, double-quote, space, and exclamation // point. // // Example: <code>My Project</code> // Read-write. Name string `json:"name,omitempty"` // Parent: An optional reference to a parent Resource. // // Supported parent types include "organization" and "folder". Once set, // the // parent cannot be cleared. The `parent` can be set on creation or // using the // `UpdateProject` method; the end user must have // the // `resourcemanager.projects.create` permission on the // parent. // // Read-write. Parent *ResourceId `json:"parent,omitempty"` // ProjectId: The unique, user-assigned ID of the Project. // It must be 6 to 30 lowercase letters, digits, or hyphens. // It must start with a letter. // Trailing hyphens are prohibited. // // Example: <code>tokyo-rain-123</code> // Read-only after creation. ProjectId string `json:"projectId,omitempty"` // ProjectNumber: The number uniquely identifying the project. // // Example: <code>415104041262</code> // Read-only. ProjectNumber int64 `json:"projectNumber,omitempty,string"` // 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 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:"-"` }
Project: A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.
func (*Project) MarshalJSON ¶
type ProjectCreationStatus ¶
type ProjectCreationStatus struct { // CreateTime: Creation time of the project creation workflow. CreateTime string `json:"createTime,omitempty"` // Gettable: True if the project can be retrieved using GetProject. No // other operations // on the project are guaranteed to work until the project creation // is // complete. Gettable bool `json:"gettable,omitempty"` // Ready: True if the project creation process is complete. Ready bool `json:"ready,omitempty"` // ForceSendFields is a list of field names (e.g. "CreateTime") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "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:"-"` }
ProjectCreationStatus: A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.
func (*ProjectCreationStatus) MarshalJSON ¶
func (s *ProjectCreationStatus) MarshalJSON() ([]byte, error)
type ProjectsCreateCall ¶
type ProjectsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsCreateCall) Context ¶
func (c *ProjectsCreateCall) Context(ctx context.Context) *ProjectsCreateCall
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 (*ProjectsCreateCall) Do ¶
func (c *ProjectsCreateCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "cloudresourcemanager.projects.create" call. Exactly one of *Project or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Project.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 (*ProjectsCreateCall) Fields ¶
func (c *ProjectsCreateCall) Fields(s ...googleapi.Field) *ProjectsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsCreateCall) Header ¶
func (c *ProjectsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsCreateCall) UseLegacyStack ¶
func (c *ProjectsCreateCall) UseLegacyStack(useLegacyStack bool) *ProjectsCreateCall
UseLegacyStack sets the optional parameter "useLegacyStack": A safety hatch to opt out of the new reliable project creation process.
type ProjectsDeleteCall ¶
type ProjectsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDeleteCall) Context ¶
func (c *ProjectsDeleteCall) Context(ctx context.Context) *ProjectsDeleteCall
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 (*ProjectsDeleteCall) Do ¶
func (c *ProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.projects.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsDeleteCall) Fields ¶
func (c *ProjectsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsDeleteCall) Header ¶
func (c *ProjectsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsGetAncestryCall ¶
type ProjectsGetAncestryCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGetAncestryCall) Context ¶
func (c *ProjectsGetAncestryCall) Context(ctx context.Context) *ProjectsGetAncestryCall
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 (*ProjectsGetAncestryCall) Do ¶
func (c *ProjectsGetAncestryCall) Do(opts ...googleapi.CallOption) (*GetAncestryResponse, error)
Do executes the "cloudresourcemanager.projects.getAncestry" call. Exactly one of *GetAncestryResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetAncestryResponse.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 (*ProjectsGetAncestryCall) Fields ¶
func (c *ProjectsGetAncestryCall) Fields(s ...googleapi.Field) *ProjectsGetAncestryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGetAncestryCall) Header ¶
func (c *ProjectsGetAncestryCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsGetCall ¶
type ProjectsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGetCall) Context ¶
func (c *ProjectsGetCall) Context(ctx context.Context) *ProjectsGetCall
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 (*ProjectsGetCall) Do ¶
func (c *ProjectsGetCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "cloudresourcemanager.projects.get" call. Exactly one of *Project or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Project.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 (*ProjectsGetCall) Fields ¶
func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGetCall) Header ¶
func (c *ProjectsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsGetCall) IfNoneMatch ¶
func (c *ProjectsGetCall) IfNoneMatch(entityTag string) *ProjectsGetCall
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 ProjectsGetIamPolicyCall ¶
type ProjectsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsGetIamPolicyCall) Context ¶
func (c *ProjectsGetIamPolicyCall) Context(ctx context.Context) *ProjectsGetIamPolicyCall
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 (*ProjectsGetIamPolicyCall) Do ¶
func (c *ProjectsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "cloudresourcemanager.projects.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsGetIamPolicyCall) Fields ¶
func (c *ProjectsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsGetIamPolicyCall) Header ¶
func (c *ProjectsGetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsListCall ¶
type ProjectsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsListCall) Context ¶
func (c *ProjectsListCall) Context(ctx context.Context) *ProjectsListCall
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 (*ProjectsListCall) Do ¶
func (c *ProjectsListCall) Do(opts ...googleapi.CallOption) (*ListProjectsResponse, error)
Do executes the "cloudresourcemanager.projects.list" call. Exactly one of *ListProjectsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListProjectsResponse.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 (*ProjectsListCall) Fields ¶
func (c *ProjectsListCall) Fields(s ...googleapi.Field) *ProjectsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsListCall) Filter ¶
func (c *ProjectsListCall) Filter(filter string) *ProjectsListCall
Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
+ `name` + `id` + `labels.<key>` (where *key* is the name of a label) + `parent.type` + `parent.id`
Some examples of using labels as filters:
| Filter | Description
| |------------------|------------------------------------------------ -----| | name:how* | The project's name starts with "how".
|
| name:Howl | The project's name is `Howl` or `howl`.
|
| name:HOWL | Equivalent to above.
|
| NAME:howl | Equivalent to above.
|
| labels.color:* | The project has the label `color`.
|
| labels.color:red | The project's label `color` has the value `red`.
|
| labels.color:red labels.size:big |The project's label `color` has
the value `red` and its label `size` has the value `big`. |
If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.
NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.
func (*ProjectsListCall) Header ¶
func (c *ProjectsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsListCall) IfNoneMatch ¶
func (c *ProjectsListCall) IfNoneMatch(entityTag string) *ProjectsListCall
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 (*ProjectsListCall) PageSize ¶
func (c *ProjectsListCall) PageSize(pageSize int64) *ProjectsListCall
PageSize sets the optional parameter "pageSize": The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default.
func (*ProjectsListCall) PageToken ¶
func (c *ProjectsListCall) PageToken(pageToken string) *ProjectsListCall
PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.
func (*ProjectsListCall) Pages ¶
func (c *ProjectsListCall) Pages(ctx context.Context, f func(*ListProjectsResponse) 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 ProjectsService ¶
type ProjectsService struct {
// contains filtered or unexported fields
}
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
func (*ProjectsService) Create ¶
func (r *ProjectsService) Create(project *Project) *ProjectsCreateCall
Create: Creates a Project resource.
Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project.
Several APIs are activated automatically for the Project, including Google Cloud Storage. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as project, folder, or organization.
This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/up dateBillingInfo) method.
func (*ProjectsService) Delete ¶
func (r *ProjectsService) Delete(projectId string) *ProjectsDeleteCall
Delete: Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if it has a lifecycle state of ACTIVE.
This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible.
Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project.
After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods.
The caller must have modify permissions for this Project.
func (*ProjectsService) Get ¶
func (r *ProjectsService) Get(projectId string) *ProjectsGetCall
Get: Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`).
The caller must have read permissions for this Project.
func (*ProjectsService) GetAncestry ¶
func (r *ProjectsService) GetAncestry(projectId string, getancestryrequest *GetAncestryRequest) *ProjectsGetAncestryCall
GetAncestry: Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`).
The caller must have read permissions for this Project.
func (*ProjectsService) GetIamPolicy ¶
func (r *ProjectsService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsGetIamPolicyCall
GetIamPolicy: Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
For additional information about resource structure and identification, see [Resource Names](/apis/design/resource_names).
func (*ProjectsService) List ¶
func (r *ProjectsService) List() *ProjectsListCall
List: Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter.
This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.
NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavorial difference.
func (*ProjectsService) SetIamPolicy ¶
func (r *ProjectsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSetIamPolicyCall
SetIamPolicy: Sets the IAM access control policy for the specified Project. Overwrites any existing policy.
The following constraints apply when using `setIamPolicy()`:
+ Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`.
+ The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization.
+ Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation.
+ A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation.
+ Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console.
+ Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected.
+ If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified.
+ This method will replace the existing policy, and cannot be used to append additional IAM settings.
Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
func (*ProjectsService) TestIamPermissions ¶
func (r *ProjectsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on the specified Project.
func (*ProjectsService) Undelete ¶
func (r *ProjectsService) Undelete(projectId string, undeleteprojectrequest *UndeleteProjectRequest) *ProjectsUndeleteCall
Undelete: Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored.
The caller must have modify permissions for this Project.
func (*ProjectsService) Update ¶
func (r *ProjectsService) Update(projectId string, project *Project) *ProjectsUpdateCall
Update: Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`).
The caller must have modify permissions for this Project.
type ProjectsSetIamPolicyCall ¶
type ProjectsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSetIamPolicyCall) Context ¶
func (c *ProjectsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSetIamPolicyCall
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 (*ProjectsSetIamPolicyCall) Do ¶
func (c *ProjectsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "cloudresourcemanager.projects.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsSetIamPolicyCall) Fields ¶
func (c *ProjectsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSetIamPolicyCall) Header ¶
func (c *ProjectsSetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsTestIamPermissionsCall ¶
type ProjectsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTestIamPermissionsCall) Context ¶
func (c *ProjectsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsTestIamPermissionsCall
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 (*ProjectsTestIamPermissionsCall) Do ¶
func (c *ProjectsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "cloudresourcemanager.projects.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 (*ProjectsTestIamPermissionsCall) Fields ¶
func (c *ProjectsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsTestIamPermissionsCall) Header ¶
func (c *ProjectsTestIamPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsUndeleteCall ¶
type ProjectsUndeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsUndeleteCall) Context ¶
func (c *ProjectsUndeleteCall) Context(ctx context.Context) *ProjectsUndeleteCall
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 (*ProjectsUndeleteCall) Do ¶
func (c *ProjectsUndeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "cloudresourcemanager.projects.undelete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsUndeleteCall) Fields ¶
func (c *ProjectsUndeleteCall) Fields(s ...googleapi.Field) *ProjectsUndeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsUndeleteCall) Header ¶
func (c *ProjectsUndeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsUpdateCall ¶
type ProjectsUpdateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsUpdateCall) Context ¶
func (c *ProjectsUpdateCall) Context(ctx context.Context) *ProjectsUpdateCall
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 (*ProjectsUpdateCall) Do ¶
func (c *ProjectsUpdateCall) Do(opts ...googleapi.CallOption) (*Project, error)
Do executes the "cloudresourcemanager.projects.update" call. Exactly one of *Project or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Project.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 (*ProjectsUpdateCall) Fields ¶
func (c *ProjectsUpdateCall) Fields(s ...googleapi.Field) *ProjectsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsUpdateCall) Header ¶
func (c *ProjectsUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ResourceId ¶
type ResourceId struct { // Id: Required field for the type-specific id. This should correspond // to the id // used in the type-specific API's. Id string `json:"id,omitempty"` // Type: Required field representing the resource type this id is // for. // At present, the valid types are "project", "folder", and // "organization". Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Id") 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:"-"` }
ResourceId: A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on.
func (*ResourceId) MarshalJSON ¶
func (s *ResourceId) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Organizations *OrganizationsService Projects *ProjectsService // contains filtered or unexported fields }
func New
deprecated
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 ¶ added in v0.3.0
NewService creates a new Service.
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 Cloud Platform services (such as // Projects) // might reject them. Policy *Policy `json:"policy,omitempty"` // UpdateMask: OPTIONAL: A FieldMask specifying which fields of the // policy to modify. Only // the fields in the mask will be modified. If no mask is provided, // the // following default mask is used: // paths: "bindings, etag" // This field is only used by Cloud IAM. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "Policy") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Policy") 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:"-"` }
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 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. "Permissions") 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:"-"` }
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 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. "Permissions") 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:"-"` }
TestIamPermissionsResponse: Response message for `TestIamPermissions` method.
func (*TestIamPermissionsResponse) MarshalJSON ¶
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
type UndeleteProjectRequest ¶
type UndeleteProjectRequest struct { }
UndeleteProjectRequest: The request sent to the UndeleteProject method.