Package cloud.google.com/go/parallelstore/apiv1beta/parallelstorepb (v0.1.1)

Variables

Instance_State_name, Instance_State_value

var (
	Instance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "DELETING",
		4: "FAILED",
	}
	Instance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"DELETING":          3,
		"FAILED":            4,
	}
)

Enum value maps for Instance_State.

File_google_cloud_parallelstore_v1beta_parallelstore_proto

var File_google_cloud_parallelstore_v1beta_parallelstore_proto protoreflect.FileDescriptor

Functions

func RegisterParallelstoreServer

func RegisterParallelstoreServer(s *grpc.Server, srv ParallelstoreServer)

CreateInstanceRequest

type CreateInstanceRequest struct {

	// Required. The instance's project and location, in the format
	// `projects/{project}/locations/{location}`.
	// Locations map to Google Cloud zones, for example **us-west1-b**.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The logical name of the Parallelstore instance in the user
	// project with the following restrictions:
	//
	// * Must contain only lowercase letters, numbers, and hyphens.
	// * Must start with a letter.
	// * Must be between 1-63 characters.
	// * Must end with a number or a letter.
	// * Must be unique within the customer project / location
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The instance to create.
	Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and t
	// he request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request for [CreateInstance][google.cloud.parallelstore.v1beta.Parallelstore.CreateInstance]

func (*CreateInstanceRequest) Descriptor

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

Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequest) GetInstance

func (x *CreateInstanceRequest) GetInstance() *Instance

func (*CreateInstanceRequest) GetInstanceId

func (x *CreateInstanceRequest) GetInstanceId() string

func (*CreateInstanceRequest) GetParent

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) GetRequestId

func (x *CreateInstanceRequest) GetRequestId() string

func (*CreateInstanceRequest) ProtoMessage

func (*CreateInstanceRequest) ProtoMessage()

func (*CreateInstanceRequest) ProtoReflect

func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Message

func (*CreateInstanceRequest) Reset

func (x *CreateInstanceRequest) Reset()

func (*CreateInstanceRequest) String

func (x *CreateInstanceRequest) String() string

DeleteInstanceRequest

type DeleteInstanceRequest struct {

	// Required. Name of the resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and t
	// he request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a Instance

func (*DeleteInstanceRequest) Descriptor

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

Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceRequest) GetName

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) GetRequestId

func (x *DeleteInstanceRequest) GetRequestId() string

func (*DeleteInstanceRequest) ProtoMessage

func (*DeleteInstanceRequest) ProtoMessage()

func (*DeleteInstanceRequest) ProtoReflect

func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Message

func (*DeleteInstanceRequest) Reset

func (x *DeleteInstanceRequest) Reset()

func (*DeleteInstanceRequest) String

func (x *DeleteInstanceRequest) String() string

GetInstanceRequest

type GetInstanceRequest struct {

	// Required. The instance resource name, in the format
	// `projects/{project_id}/locations/{location}/instances/{instance_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to get an instance's details.

func (*GetInstanceRequest) Descriptor

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetName

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

func (x *GetInstanceRequest) ProtoReflect() protoreflect.Message

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

Instance

type Instance struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`

	State Instance_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.cloud.parallelstore.v1beta.Instance_State" json:"state,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	CapacityGib int64 `protobuf:"varint,8,opt,name=capacity_gib,json=capacityGib,proto3" json:"capacity_gib,omitempty"`

	DaosVersion string `protobuf:"bytes,9,opt,name=daos_version,json=daosVersion,proto3" json:"daos_version,omitempty"`

	AccessPoints []string `protobuf:"bytes,10,rep,name=access_points,json=accessPoints,proto3" json:"access_points,omitempty"`

	Network string `protobuf:"bytes,11,opt,name=network,proto3" json:"network,omitempty"`

	ReservedIpRange string `protobuf:"bytes,12,opt,name=reserved_ip_range,json=reservedIpRange,proto3" json:"reserved_ip_range,omitempty"`

}

A Parallelstore instance.

func (*Instance) Descriptor

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAccessPoints

func (x *Instance) GetAccessPoints() []string

func (*Instance) GetCapacityGib

func (x *Instance) GetCapacityGib() int64

func (*Instance) GetCreateTime

func (x *Instance) GetCreateTime() *timestamppb.Timestamp

func (*Instance) GetDaosVersion

func (x *Instance) GetDaosVersion() string

func (*Instance) GetDescription

func (x *Instance) GetDescription() string

func (*Instance) GetLabels

func (x *Instance) GetLabels() map[string]string

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetNetwork

func (x *Instance) GetNetwork() string

func (*Instance) GetReservedIpRange

func (x *Instance) GetReservedIpRange() string

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetUpdateTime

func (x *Instance) GetUpdateTime() *timestamppb.Timestamp

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

func (x *Instance) ProtoReflect() protoreflect.Message

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

Instance_State

type Instance_State int32

Represents the different states of a Parallelstore instance.

Instance_STATE_UNSPECIFIED, Instance_CREATING, Instance_ACTIVE, Instance_DELETING, Instance_FAILED

const (
	// Not set.
	Instance_STATE_UNSPECIFIED Instance_State = 0
	// The instance is being created.
	Instance_CREATING Instance_State = 1
	// The instance is available for use.
	Instance_ACTIVE Instance_State = 2
	// The instance is being deleted.
	Instance_DELETING Instance_State = 3
	// The instance is not usable.
	Instance_FAILED Instance_State = 4
)

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

ListInstancesRequest

type ListInstancesRequest struct {

	// Required. The project and location for which to retrieve instance
	// information, in the format `projects/{project_id}/locations/{location}`.
	// For Parallelstore locations map to Google Cloud zones, for example
	// **us-central1-a**.
	// To retrieve instance information for all locations, use "-" for the
	// `{location}` value.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Instances

func (*ListInstancesRequest) Descriptor

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetFilter

func (x *ListInstancesRequest) GetFilter() string

func (*ListInstancesRequest) GetOrderBy

func (x *ListInstancesRequest) GetOrderBy() string

func (*ListInstancesRequest) GetPageSize

func (x *ListInstancesRequest) GetPageSize() int32

func (*ListInstancesRequest) GetPageToken

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) GetParent

func (x *ListInstancesRequest) GetParent() string

func (*ListInstancesRequest) ProtoMessage

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect

func (x *ListInstancesRequest) ProtoReflect() protoreflect.Message

func (*ListInstancesRequest) Reset

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String

func (x *ListInstancesRequest) String() string

ListInstancesResponse

type ListInstancesResponse struct {

	// The list of Parallelstore Instances
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Instances

func (*ListInstancesResponse) Descriptor

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances

func (x *ListInstancesResponse) GetInstances() []*Instance

func (*ListInstancesResponse) GetNextPageToken

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) GetUnreachable

func (x *ListInstancesResponse) GetUnreachable() []string

func (*ListInstancesResponse) ProtoMessage

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect

func (x *ListInstancesResponse) ProtoReflect() protoreflect.Message

func (*ListInstancesResponse) Reset

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String

func (x *ListInstancesResponse) String() string

OperationMetadata

type OperationMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have been cancelled successfully
	// have [Operation.error][] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestamp

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

ParallelstoreClient

type ParallelstoreClient interface {
	// Lists Instances in a given project and location.
	ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
	// Creates a Parallelstore instance in a given project and location.
	CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Instance.
	UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ParallelstoreClient is the client API for Parallelstore service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewParallelstoreClient

func NewParallelstoreClient(cc grpc.ClientConnInterface) ParallelstoreClient

ParallelstoreServer

type ParallelstoreServer interface {
	// Lists Instances in a given project and location.
	ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
	// Creates a Parallelstore instance in a given project and location.
	CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Instance.
	UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)
}

ParallelstoreServer is the server API for Parallelstore service.

UnimplementedParallelstoreServer

type UnimplementedParallelstoreServer struct {
}

UnimplementedParallelstoreServer can be embedded to have forward compatible implementations.

func (*UnimplementedParallelstoreServer) CreateInstance

func (*UnimplementedParallelstoreServer) DeleteInstance

func (*UnimplementedParallelstoreServer) GetInstance

func (*UnimplementedParallelstoreServer) ListInstances

func (*UnimplementedParallelstoreServer) UpdateInstance

UpdateInstanceRequest

type UpdateInstanceRequest struct {

	// Required. Mask of fields to update .Field mask is used to specify the
	// fields to be overwritten in the Instance resource by the update. At least
	// one path must be supplied in this field. The fields specified in the
	// update_mask are relative to the resource, not the full request.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The instance to update
	Instance *Instance `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and t
	// he request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Instance

func (*UpdateInstanceRequest) Descriptor

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

Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceRequest) GetInstance

func (x *UpdateInstanceRequest) GetInstance() *Instance

func (*UpdateInstanceRequest) GetRequestId

func (x *UpdateInstanceRequest) GetRequestId() string

func (*UpdateInstanceRequest) GetUpdateMask

func (x *UpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateInstanceRequest) ProtoMessage

func (*UpdateInstanceRequest) ProtoMessage()

func (*UpdateInstanceRequest) ProtoReflect

func (x *UpdateInstanceRequest) ProtoReflect() protoreflect.Message

func (*UpdateInstanceRequest) Reset

func (x *UpdateInstanceRequest) Reset()

func (*UpdateInstanceRequest) String

func (x *UpdateInstanceRequest) String() string