google_cloud_resourcemanager_v2

package
v0.0.0-...-dbc791b Latest Latest
Warning

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

Go to latest
Published: Dec 3, 2017 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var FolderOperation_OperationType_name = map[int32]string{
	0: "OPERATION_TYPE_UNSPECIFIED",
	1: "CREATE",
	2: "MOVE",
}
View Source
var FolderOperation_OperationType_value = map[string]int32{
	"OPERATION_TYPE_UNSPECIFIED": 0,
	"CREATE":                     1,
	"MOVE":                       2,
}
View Source
var Folder_LifecycleState_name = map[int32]string{
	0: "LIFECYCLE_STATE_UNSPECIFIED",
	1: "ACTIVE",
	2: "DELETE_REQUESTED",
}
View Source
var Folder_LifecycleState_value = map[string]int32{
	"LIFECYCLE_STATE_UNSPECIFIED": 0,
	"ACTIVE":                      1,
	"DELETE_REQUESTED":            2,
}

Functions

This section is empty.

Types

type CreateFolderRequest

type CreateFolderRequest struct {
	// The resource name of the new Folder's parent.
	// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The Folder being created, only the display name will be consulted.
	// All other fields will be ignored.
	Folder *Folder `protobuf:"bytes,2,opt,name=folder" json:"folder,omitempty"`
}

The CreateFolder request message.

func (*CreateFolderRequest) Descriptor

func (*CreateFolderRequest) Descriptor() ([]byte, []int)

func (*CreateFolderRequest) GetFolder

func (m *CreateFolderRequest) GetFolder() *Folder

func (*CreateFolderRequest) GetParent

func (m *CreateFolderRequest) GetParent() string

func (*CreateFolderRequest) ProtoMessage

func (*CreateFolderRequest) ProtoMessage()

func (*CreateFolderRequest) Reset

func (m *CreateFolderRequest) Reset()

func (*CreateFolderRequest) String

func (m *CreateFolderRequest) String() string

type DeleteFolderRequest

type DeleteFolderRequest struct {
	// the resource name of the Folder to be deleted.
	// Must be of the form `folders/{folder_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Instructs DeleteFolderAction to delete a folder even when the folder is not
	// empty.
	RecursiveDelete bool `protobuf:"varint,2,opt,name=recursive_delete,json=recursiveDelete,proto3" json:"recursive_delete,omitempty"`
}

The DeleteFolder request message.

func (*DeleteFolderRequest) Descriptor

func (*DeleteFolderRequest) Descriptor() ([]byte, []int)

func (*DeleteFolderRequest) GetName

func (m *DeleteFolderRequest) GetName() string

func (*DeleteFolderRequest) GetRecursiveDelete

func (m *DeleteFolderRequest) GetRecursiveDelete() bool

func (*DeleteFolderRequest) ProtoMessage

func (*DeleteFolderRequest) ProtoMessage()

func (*DeleteFolderRequest) Reset

func (m *DeleteFolderRequest) Reset()

func (*DeleteFolderRequest) String

func (m *DeleteFolderRequest) String() string

type Folder

type Folder struct {
	// Output only. The resource name of the Folder.
	// Its format is `folders/{folder_id}`, for example: "folders/1234".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The Folder’s parent's resource name.
	// Updates to the folder's parent must be performed via [MoveFolders].
	Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
	// The folder’s display name.
	// A folder’s display name must be unique amongst its siblings, e.g.
	// no two folders with the same parent can share the same display name.
	// The display name must start and end with a letter or digit, may contain
	// letters, digits, spaces, hyphens and underscores and can be no longer
	// than 30 characters. This is captured by the regular expression:
	// [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only.  The lifecycle state of the folder.
	// Updates to the lifecycle_state must be performed via
	// [DeleteFolder] and [UndeleteFolder].
	LifecycleState Folder_LifecycleState `` /* 163-byte string literal not displayed */
	// Output only. Timestamp when the Folder was created. Assigned by the server.
	CreateTime *google_protobuf4.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime" json:"create_time,omitempty"`
	// Output only. Timestamp when the Folder was last modified.
	UpdateTime *google_protobuf4.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
}

A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.

func (*Folder) Descriptor

func (*Folder) Descriptor() ([]byte, []int)

func (*Folder) GetCreateTime

func (m *Folder) GetCreateTime() *google_protobuf4.Timestamp

func (*Folder) GetDisplayName

func (m *Folder) GetDisplayName() string

func (*Folder) GetLifecycleState

func (m *Folder) GetLifecycleState() Folder_LifecycleState

func (*Folder) GetName

func (m *Folder) GetName() string

func (*Folder) GetParent

func (m *Folder) GetParent() string

func (*Folder) GetUpdateTime

func (m *Folder) GetUpdateTime() *google_protobuf4.Timestamp

func (*Folder) ProtoMessage

func (*Folder) ProtoMessage()

func (*Folder) Reset

func (m *Folder) Reset()

func (*Folder) String

func (m *Folder) String() string

type FolderOperation

type FolderOperation struct {
	// The display name of the folder.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The type of this operation.
	OperationType FolderOperation_OperationType `` /* 168-byte string literal not displayed */
	// The resource name of the folder's parent.
	// Only applicable when the operation_type is MOVE.
	SourceParent string `protobuf:"bytes,3,opt,name=source_parent,json=sourceParent,proto3" json:"source_parent,omitempty"`
	// The resource name of the folder or organization we are either creating
	// the folder under or moving the folder to.
	DestinationParent string `protobuf:"bytes,4,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
}

Metadata describing a long running folder operation

func (*FolderOperation) Descriptor

func (*FolderOperation) Descriptor() ([]byte, []int)

func (*FolderOperation) GetDestinationParent

func (m *FolderOperation) GetDestinationParent() string

func (*FolderOperation) GetDisplayName

func (m *FolderOperation) GetDisplayName() string

func (*FolderOperation) GetOperationType

func (m *FolderOperation) GetOperationType() FolderOperation_OperationType

func (*FolderOperation) GetSourceParent

func (m *FolderOperation) GetSourceParent() string

func (*FolderOperation) ProtoMessage

func (*FolderOperation) ProtoMessage()

func (*FolderOperation) Reset

func (m *FolderOperation) Reset()

func (*FolderOperation) String

func (m *FolderOperation) String() string

type FolderOperation_OperationType

type FolderOperation_OperationType int32

The type of operation that failed.

const (
	// Operation type not specified.
	FolderOperation_OPERATION_TYPE_UNSPECIFIED FolderOperation_OperationType = 0
	// A create folder operation.
	FolderOperation_CREATE FolderOperation_OperationType = 1
	// A move folder operation.
	FolderOperation_MOVE FolderOperation_OperationType = 2
)

func (FolderOperation_OperationType) EnumDescriptor

func (FolderOperation_OperationType) EnumDescriptor() ([]byte, []int)

func (FolderOperation_OperationType) String

type Folder_LifecycleState

type Folder_LifecycleState int32

Folder lifecycle states.

const (
	// Unspecified state.
	Folder_LIFECYCLE_STATE_UNSPECIFIED Folder_LifecycleState = 0
	// The normal and active state.
	Folder_ACTIVE Folder_LifecycleState = 1
	// The folder has been marked for deletion by the user.
	Folder_DELETE_REQUESTED Folder_LifecycleState = 2
)

func (Folder_LifecycleState) EnumDescriptor

func (Folder_LifecycleState) EnumDescriptor() ([]byte, []int)

func (Folder_LifecycleState) String

func (x Folder_LifecycleState) String() string

type GetFolderRequest

type GetFolderRequest struct {
	// The resource name of the Folder to retrieve.
	// Must be of the form `folders/{folder_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}

The GetFolder request message.

func (*GetFolderRequest) Descriptor

func (*GetFolderRequest) Descriptor() ([]byte, []int)

func (*GetFolderRequest) GetName

func (m *GetFolderRequest) GetName() string

func (*GetFolderRequest) ProtoMessage

func (*GetFolderRequest) ProtoMessage()

func (*GetFolderRequest) Reset

func (m *GetFolderRequest) Reset()

func (*GetFolderRequest) String

func (m *GetFolderRequest) String() string

type ListFoldersRequest

type ListFoldersRequest struct {
	// The resource name of the Organization or Folder whose Folders are
	// being listed.
	// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
	// Access to this method is controlled by checking the
	// `resourcemanager.folders.list` permission on the `parent`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of Folders to return in the response.
	// This field is optional.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A pagination token returned from a previous call to `ListFolders`
	// that indicates where this listing should continue from.
	// This field is optional.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Controls whether Folders in the [DELETE_REQUESTED} state should
	// be returned.
	ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
}

The ListFolders request message.

func (*ListFoldersRequest) Descriptor

func (*ListFoldersRequest) Descriptor() ([]byte, []int)

func (*ListFoldersRequest) GetPageSize

func (m *ListFoldersRequest) GetPageSize() int32

func (*ListFoldersRequest) GetPageToken

func (m *ListFoldersRequest) GetPageToken() string

func (*ListFoldersRequest) GetParent

func (m *ListFoldersRequest) GetParent() string

func (*ListFoldersRequest) GetShowDeleted

func (m *ListFoldersRequest) GetShowDeleted() bool

func (*ListFoldersRequest) ProtoMessage

func (*ListFoldersRequest) ProtoMessage()

func (*ListFoldersRequest) Reset

func (m *ListFoldersRequest) Reset()

func (*ListFoldersRequest) String

func (m *ListFoldersRequest) String() string

type ListFoldersResponse

type ListFoldersResponse struct {
	// A possibly paginated list of Folders that are direct descendants of
	// the specified parent resource.
	Folders []*Folder `protobuf:"bytes,1,rep,name=folders" json:"folders,omitempty"`
	// A pagination token returned from a previous call to `ListFolders`
	// that indicates from where listing should continue.
	// This field is optional.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
}

The ListFolders response message.

func (*ListFoldersResponse) Descriptor

func (*ListFoldersResponse) Descriptor() ([]byte, []int)

func (*ListFoldersResponse) GetFolders

func (m *ListFoldersResponse) GetFolders() []*Folder

func (*ListFoldersResponse) GetNextPageToken

func (m *ListFoldersResponse) GetNextPageToken() string

func (*ListFoldersResponse) ProtoMessage

func (*ListFoldersResponse) ProtoMessage()

func (*ListFoldersResponse) Reset

func (m *ListFoldersResponse) Reset()

func (*ListFoldersResponse) String

func (m *ListFoldersResponse) String() string

type MoveFolderRequest

type MoveFolderRequest struct {
	// The resource name of the Folder to move.
	// Must be of the form folders/{folder_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The resource name of the Folder or Organization to reparent
	// the folder under.
	// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
	DestinationParent string `protobuf:"bytes,2,opt,name=destination_parent,json=destinationParent,proto3" json:"destination_parent,omitempty"`
}

The MoveFolder request message.

func (*MoveFolderRequest) Descriptor

func (*MoveFolderRequest) Descriptor() ([]byte, []int)

func (*MoveFolderRequest) GetDestinationParent

func (m *MoveFolderRequest) GetDestinationParent() string

func (*MoveFolderRequest) GetName

func (m *MoveFolderRequest) GetName() string

func (*MoveFolderRequest) ProtoMessage

func (*MoveFolderRequest) ProtoMessage()

func (*MoveFolderRequest) Reset

func (m *MoveFolderRequest) Reset()

func (*MoveFolderRequest) String

func (m *MoveFolderRequest) String() string

type SearchFoldersRequest

type SearchFoldersRequest struct {
	// The maximum number of folders to return in the response.
	// This field is optional.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A pagination token returned from a previous call to `SearchFolders`
	// that indicates from where search should continue.
	// This field is optional.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Search criteria used to select the Folders to return.
	// If no search criteria is specified then all accessible folders will be
	// returned.
	//
	// Query expressions can be used to restrict results based upon displayName,
	// lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
	// can be used along with the suffix wildcard symbol `*`.
	//
	// Some example queries are:
	// |Query|Description|
	// |------|-----------|
	// |displayName=Test*|Folders whose display name starts with "Test".|
	// |lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|
	// |parent=folders/123|Folders whose parent is "folders/123".|
	// |parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose
	// parent is "folders/123".|
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
}

The request message for searching folders.

func (*SearchFoldersRequest) Descriptor

func (*SearchFoldersRequest) Descriptor() ([]byte, []int)

func (*SearchFoldersRequest) GetPageSize

func (m *SearchFoldersRequest) GetPageSize() int32

func (*SearchFoldersRequest) GetPageToken

func (m *SearchFoldersRequest) GetPageToken() string

func (*SearchFoldersRequest) GetQuery

func (m *SearchFoldersRequest) GetQuery() string

func (*SearchFoldersRequest) ProtoMessage

func (*SearchFoldersRequest) ProtoMessage()

func (*SearchFoldersRequest) Reset

func (m *SearchFoldersRequest) Reset()

func (*SearchFoldersRequest) String

func (m *SearchFoldersRequest) String() string

type SearchFoldersResponse

type SearchFoldersResponse struct {
	// A possibly paginated folder search results.
	// the specified parent resource.
	Folders []*Folder `protobuf:"bytes,1,rep,name=folders" json:"folders,omitempty"`
	// A pagination token returned from a previous call to `SearchFolders`
	// that indicates from where searching should continue.
	// This field is optional.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
}

The response message for searching folders.

func (*SearchFoldersResponse) Descriptor

func (*SearchFoldersResponse) Descriptor() ([]byte, []int)

func (*SearchFoldersResponse) GetFolders

func (m *SearchFoldersResponse) GetFolders() []*Folder

func (*SearchFoldersResponse) GetNextPageToken

func (m *SearchFoldersResponse) GetNextPageToken() string

func (*SearchFoldersResponse) ProtoMessage

func (*SearchFoldersResponse) ProtoMessage()

func (*SearchFoldersResponse) Reset

func (m *SearchFoldersResponse) Reset()

func (*SearchFoldersResponse) String

func (m *SearchFoldersResponse) String() string

type UndeleteFolderRequest

type UndeleteFolderRequest struct {
	// The resource name of the Folder to undelete.
	// Must be of the form `folders/{folder_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}

The UndeleteFolder request message.

func (*UndeleteFolderRequest) Descriptor

func (*UndeleteFolderRequest) Descriptor() ([]byte, []int)

func (*UndeleteFolderRequest) GetName

func (m *UndeleteFolderRequest) GetName() string

func (*UndeleteFolderRequest) ProtoMessage

func (*UndeleteFolderRequest) ProtoMessage()

func (*UndeleteFolderRequest) Reset

func (m *UndeleteFolderRequest) Reset()

func (*UndeleteFolderRequest) String

func (m *UndeleteFolderRequest) String() string

type UpdateFolderRequest

type UpdateFolderRequest struct {
	// The new definition of the Folder. It must include a
	// a `name` and `display_name` field. The other fields
	// will be ignored.
	Folder *Folder `protobuf:"bytes,1,opt,name=folder" json:"folder,omitempty"`
	// Fields to be updated.
	// Only the `display_name` can be updated.
	UpdateMask *google_protobuf3.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
}

The request message for updating a folder's display name.

func (*UpdateFolderRequest) Descriptor

func (*UpdateFolderRequest) Descriptor() ([]byte, []int)

func (*UpdateFolderRequest) GetFolder

func (m *UpdateFolderRequest) GetFolder() *Folder

func (*UpdateFolderRequest) GetUpdateMask

func (m *UpdateFolderRequest) GetUpdateMask() *google_protobuf3.FieldMask

func (*UpdateFolderRequest) ProtoMessage

func (*UpdateFolderRequest) ProtoMessage()

func (*UpdateFolderRequest) Reset

func (m *UpdateFolderRequest) Reset()

func (*UpdateFolderRequest) String

func (m *UpdateFolderRequest) String() string

Jump to

Keyboard shortcuts

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