cloudresourcemanager

package
v0.0.0-...-375ceb8 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package cloudresourcemanager provides access to the Google Cloud Resource Manager API.

See https://cloud.google.com/resource-manager

Usage example: 

import "google.golang.org/api/cloudresourcemanager/v1beta1"
...
cloudresourcemanagerService, err := cloudresourcemanager.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty 

type Empty struct {
}

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 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. Note: pagination is not
	// yet supported; the server will not set this field.
	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"`
}

ListProjectsResponse: A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperP rojects.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.

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\])?)?. 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: "environment" : "dev"
	// Read-write.
	Labels map[string]string `json:"labels,omitempty"`

	// LifecycleState: The project lifecycle state. Read-only.
	//
	// Possible values:
	//   "LIFECYCLE_STATE_UNSPECIFIED"
	//   "ACTIVE"
	//   "DELETE_REQUESTED"
	//   "DELETE_IN_PROGRESS"
	LifecycleState string `json:"lifecycleState,omitempty"`

	// Name: The user-assigned name of the project. This field is optional
	// and can remain unset. Allowed characters are: lowercase and uppercase
	// letters, numbers, hyphen, single-quote, double-quote, space, and
	// exclamation point. Example: My Project Read-write.
	Name string `json:"name,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: tokyo-rain-123
	// Read-only after creation.
	ProjectId string `json:"projectId,omitempty"`

	// ProjectNumber: The number uniquely identifying the project. Example:
	// 415104041262 Read-only.
	ProjectNumber int64 `json:"projectNumber,omitempty,string"`
}

Project: A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.

type ProjectsCreateCall 

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

func (*ProjectsCreateCall) Do 

func (c *ProjectsCreateCall) Do() (*Project, error)

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.

type ProjectsDeleteCall 

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

func (*ProjectsDeleteCall) Do 

func (c *ProjectsDeleteCall) Do() (*Empty, error)

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.

type ProjectsGetCall 

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

func (*ProjectsGetCall) Do 

func (c *ProjectsGetCall) Do() (*Project, error)

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.

type ProjectsListCall 

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

func (*ProjectsListCall) Do 

func (c *ProjectsListCall) Do() (*ListProjectsResponse, error)

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 Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |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 label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.

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. Note: pagination is not yet supported; the server ignores this field.

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 ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field.

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.

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 the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.A CTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.A CTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_RE QUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN _PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetPro ject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListPr ojects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetPro ject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListPr ojects] 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) List 

func (r *ProjectsService) List() *ProjectsListCall

List: Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.

func (*ProjectsService) Undelete 

func (r *ProjectsService) Undelete(projectId string) *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] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_RE QUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN _PROGRESS], 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 ProjectsUndeleteCall 

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

func (*ProjectsUndeleteCall) Do 

func (c *ProjectsUndeleteCall) Do() (*Empty, error)

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.

type ProjectsUpdateCall 

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

func (*ProjectsUpdateCall) Do 

func (c *ProjectsUpdateCall) Do() (*Project, error)

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.

type Service 

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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