resourcesettingspb

package
v1.6.6 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SettingView_name = map[int32]string{
		0: "SETTING_VIEW_UNSPECIFIED",
		1: "SETTING_VIEW_BASIC",
		2: "SETTING_VIEW_EFFECTIVE_VALUE",
		3: "SETTING_VIEW_LOCAL_VALUE",
	}
	SettingView_value = map[string]int32{
		"SETTING_VIEW_UNSPECIFIED":     0,
		"SETTING_VIEW_BASIC":           1,
		"SETTING_VIEW_EFFECTIVE_VALUE": 2,
		"SETTING_VIEW_LOCAL_VALUE":     3,
	}
)

Enum value maps for SettingView.

View Source 
var (
	SettingMetadata_DataType_name = map[int32]string{
		0: "DATA_TYPE_UNSPECIFIED",
		1: "BOOLEAN",
		2: "STRING",
		3: "STRING_SET",
		4: "ENUM_VALUE",
	}
	SettingMetadata_DataType_value = map[string]int32{
		"DATA_TYPE_UNSPECIFIED": 0,
		"BOOLEAN":               1,
		"STRING":                2,
		"STRING_SET":            3,
		"ENUM_VALUE":            4,
	}
)

Enum value maps for SettingMetadata_DataType.

View Source 
var File_google_cloud_resourcesettings_v1_resource_settings_proto protoreflect.FileDescriptor

Functions

func RegisterResourceSettingsServiceServer 

func RegisterResourceSettingsServiceServer(s *grpc.Server, srv ResourceSettingsServiceServer)

Types

type GetSettingRequest 

type GetSettingRequest struct {

	// Required. The name of the setting to get. See [Setting][google.cloud.resourcesettings.v1.Setting] for naming
	// requirements.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The SettingView for this request.
	View SettingView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.resourcesettings.v1.SettingView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

The request for GetSetting.

func (*GetSettingRequest) Descriptor deprecated 

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

Deprecated: Use GetSettingRequest.ProtoReflect.Descriptor instead.

func (*GetSettingRequest) GetName 

func (x *GetSettingRequest) GetName() string

func (*GetSettingRequest) GetView 

func (x *GetSettingRequest) GetView() SettingView

func (*GetSettingRequest) ProtoMessage 

func (*GetSettingRequest) ProtoMessage()

func (*GetSettingRequest) ProtoReflect 

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

func (*GetSettingRequest) Reset 

func (x *GetSettingRequest) Reset()

func (*GetSettingRequest) String 

func (x *GetSettingRequest) String() string

type ListSettingsRequest 

type ListSettingsRequest struct {

	// Required. The Cloud resource that parents the setting. Must be in one of the
	// following forms:
	//
	// * `projects/{project_number}`
	// * `projects/{project_id}`
	// * `folders/{folder_id}`
	// * `organizations/{organization_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Unused. The size of the page to be returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Unused. A page token used to retrieve the next page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The SettingView for this request.
	View SettingView `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.resourcesettings.v1.SettingView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

The request for ListSettings.

func (*ListSettingsRequest) Descriptor deprecated 

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

Deprecated: Use ListSettingsRequest.ProtoReflect.Descriptor instead.

func (*ListSettingsRequest) GetPageSize 

func (x *ListSettingsRequest) GetPageSize() int32

func (*ListSettingsRequest) GetPageToken 

func (x *ListSettingsRequest) GetPageToken() string

func (*ListSettingsRequest) GetParent 

func (x *ListSettingsRequest) GetParent() string

func (*ListSettingsRequest) GetView 

func (x *ListSettingsRequest) GetView() SettingView

func (*ListSettingsRequest) ProtoMessage 

func (*ListSettingsRequest) ProtoMessage()

func (*ListSettingsRequest) ProtoReflect 

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

func (*ListSettingsRequest) Reset 

func (x *ListSettingsRequest) Reset()

func (*ListSettingsRequest) String 

func (x *ListSettingsRequest) String() string

type ListSettingsResponse 

type ListSettingsResponse struct {

	// A list of settings that are available at the specified Cloud resource.
	Settings []*Setting `protobuf:"bytes,1,rep,name=settings,proto3" json:"settings,omitempty"`
	// Unused. A page token used to retrieve the next page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response from ListSettings.

func (*ListSettingsResponse) Descriptor deprecated 

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

Deprecated: Use ListSettingsResponse.ProtoReflect.Descriptor instead.

func (*ListSettingsResponse) GetNextPageToken 

func (x *ListSettingsResponse) GetNextPageToken() string

func (*ListSettingsResponse) GetSettings 

func (x *ListSettingsResponse) GetSettings() []*Setting

func (*ListSettingsResponse) ProtoMessage 

func (*ListSettingsResponse) ProtoMessage()

func (*ListSettingsResponse) ProtoReflect 

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

func (*ListSettingsResponse) Reset 

func (x *ListSettingsResponse) Reset()

func (*ListSettingsResponse) String 

func (x *ListSettingsResponse) String() string

type ResourceSettingsServiceClient 

type ResourceSettingsServiceClient interface {
	// Lists all the settings that are available on the Cloud resource `parent`.
	ListSettings(ctx context.Context, in *ListSettingsRequest, opts ...grpc.CallOption) (*ListSettingsResponse, error)
	// Gets a setting.
	//
	// Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
	// setting does not exist.
	GetSetting(ctx context.Context, in *GetSettingRequest, opts ...grpc.CallOption) (*Setting, error)
	// Updates a setting.
	//
	// Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
	// setting does not exist.
	// Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if
	// the setting is flagged as read only.
	// Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag
	// supplied in the request does not match the persisted etag of the setting
	// value.
	//
	// On success, the response will contain only `name`, `local_value` and
	// `etag`.  The `metadata` and `effective_value` cannot be updated through
	// this API.
	//
	// Note: the supplied setting will perform a full overwrite of the
	// `local_value` field.
	UpdateSetting(ctx context.Context, in *UpdateSettingRequest, opts ...grpc.CallOption) (*Setting, error)
}

ResourceSettingsServiceClient is the client API for ResourceSettingsService service.

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

func NewResourceSettingsServiceClient 

func NewResourceSettingsServiceClient(cc grpc.ClientConnInterface) ResourceSettingsServiceClient

type ResourceSettingsServiceServer 

type ResourceSettingsServiceServer interface {
	// Lists all the settings that are available on the Cloud resource `parent`.
	ListSettings(context.Context, *ListSettingsRequest) (*ListSettingsResponse, error)
	// Gets a setting.
	//
	// Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
	// setting does not exist.
	GetSetting(context.Context, *GetSettingRequest) (*Setting, error)
	// Updates a setting.
	//
	// Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
	// setting does not exist.
	// Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if
	// the setting is flagged as read only.
	// Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag
	// supplied in the request does not match the persisted etag of the setting
	// value.
	//
	// On success, the response will contain only `name`, `local_value` and
	// `etag`.  The `metadata` and `effective_value` cannot be updated through
	// this API.
	//
	// Note: the supplied setting will perform a full overwrite of the
	// `local_value` field.
	UpdateSetting(context.Context, *UpdateSettingRequest) (*Setting, error)
}

ResourceSettingsServiceServer is the server API for ResourceSettingsService service.

type Setting 

type Setting struct {

	// The resource name of the setting. Must be in one of the following forms:
	//
	// * `projects/{project_number}/settings/{setting_name}`
	// * `folders/{folder_id}/settings/{setting_name}`
	// * `organizations/{organization_id}/settings/{setting_name}`
	//
	// For example, "/projects/123/settings/gcp-enableMyFeature"
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Metadata about a setting which is not editable by the end user.
	Metadata *SettingMetadata `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The configured value of the setting at the given parent resource (ignoring
	// the resource hierarchy). The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
	// consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
	LocalValue *Value `protobuf:"bytes,8,opt,name=local_value,json=localValue,proto3" json:"local_value,omitempty"`
	// Output only. The computed effective value of the setting at the given parent resource
	// (based on the resource hierarchy).
	//
	// The effective value evaluates to one of the following options in the given
	// order (the next option is used if the previous one does not exist):
	//
	//  1. the local setting value on the given resource: [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value]
	//  2. if one of the given resource's ancestors have a local setting value,
	//     the local value at the nearest such ancestor
	//  3. the setting's default value: [SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value]
	//  4. an empty value (defined as a `Value` with all fields unset)
	//
	// The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
	// consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
	EffectiveValue *Value `protobuf:"bytes,9,opt,name=effective_value,json=effectiveValue,proto3" json:"effective_value,omitempty"`
	// A fingerprint used for optimistic concurrency. See
	// [UpdateSetting][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting] for more
	// details.
	Etag string `protobuf:"bytes,10,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

The schema for settings.

func (*Setting) Descriptor deprecated 

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

Deprecated: Use Setting.ProtoReflect.Descriptor instead.

func (*Setting) GetEffectiveValue 

func (x *Setting) GetEffectiveValue() *Value

func (*Setting) GetEtag 

func (x *Setting) GetEtag() string

func (*Setting) GetLocalValue 

func (x *Setting) GetLocalValue() *Value

func (*Setting) GetMetadata 

func (x *Setting) GetMetadata() *SettingMetadata

func (*Setting) GetName 

func (x *Setting) GetName() string

func (*Setting) ProtoMessage 

func (*Setting) ProtoMessage()

func (*Setting) ProtoReflect 

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

func (*Setting) Reset 

func (x *Setting) Reset()

func (*Setting) String 

func (x *Setting) String() string

type SettingMetadata 

type SettingMetadata struct {

	// The human readable name for this setting.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A detailed description of what this setting does.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// A flag indicating that values of this setting cannot be modified (see
	// documentation of the specific setting for updates and reasons).
	ReadOnly bool `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// The data type for this setting.
	DataType SettingMetadata_DataType `` /* 149-byte string literal not displayed */
	// The value provided by [Setting.effective_value][google.cloud.resourcesettings.v1.Setting.effective_value] if no setting value is
	// explicitly set.
	//
	// Note: not all settings have a default value.
	DefaultValue *Value `protobuf:"bytes,5,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

Metadata about a setting which is not editable by the end user.

func (*SettingMetadata) Descriptor deprecated 

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

Deprecated: Use SettingMetadata.ProtoReflect.Descriptor instead.

func (*SettingMetadata) GetDataType 

func (x *SettingMetadata) GetDataType() SettingMetadata_DataType

func (*SettingMetadata) GetDefaultValue 

func (x *SettingMetadata) GetDefaultValue() *Value

func (*SettingMetadata) GetDescription 

func (x *SettingMetadata) GetDescription() string

func (*SettingMetadata) GetDisplayName 

func (x *SettingMetadata) GetDisplayName() string

func (*SettingMetadata) GetReadOnly 

func (x *SettingMetadata) GetReadOnly() bool

func (*SettingMetadata) ProtoMessage 

func (*SettingMetadata) ProtoMessage()

func (*SettingMetadata) ProtoReflect 

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

func (*SettingMetadata) Reset 

func (x *SettingMetadata) Reset()

func (*SettingMetadata) String 

func (x *SettingMetadata) String() string

type SettingMetadata_DataType 

type SettingMetadata_DataType int32

The data type for setting values of this setting. See Value[google.cloud.resourcesettings.v1.Value] for more details on the available data types. 

const (
	// Unspecified data type.
	SettingMetadata_DATA_TYPE_UNSPECIFIED SettingMetadata_DataType = 0
	// A boolean setting.
	SettingMetadata_BOOLEAN SettingMetadata_DataType = 1
	// A string setting.
	SettingMetadata_STRING SettingMetadata_DataType = 2
	// A string set setting.
	SettingMetadata_STRING_SET SettingMetadata_DataType = 3
	// A Enum setting
	SettingMetadata_ENUM_VALUE SettingMetadata_DataType = 4
)

func (SettingMetadata_DataType) Descriptor 

func (SettingMetadata_DataType) Descriptor() protoreflect.EnumDescriptor

func (SettingMetadata_DataType) Enum 

func (x SettingMetadata_DataType) Enum() *SettingMetadata_DataType

func (SettingMetadata_DataType) EnumDescriptor deprecated 

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

Deprecated: Use SettingMetadata_DataType.Descriptor instead.

func (SettingMetadata_DataType) Number 

func (x SettingMetadata_DataType) Number() protoreflect.EnumNumber

func (SettingMetadata_DataType) String 

func (x SettingMetadata_DataType) String() string

func (SettingMetadata_DataType) Type 

func (SettingMetadata_DataType) Type() protoreflect.EnumType

type SettingView 

type SettingView int32

View options for Settings. 

const (
	// The default / unset value.
	// The API will default to the SETTING_VIEW_BASIC view.
	SettingView_SETTING_VIEW_UNSPECIFIED SettingView = 0
	// Include [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata], but nothing else.
	// This is the default value (for both ListSettings and GetSetting).
	SettingView_SETTING_VIEW_BASIC SettingView = 1
	// Include [Setting.effective_value][google.cloud.resourcesettings.v1.Setting.effective_value], but nothing else.
	SettingView_SETTING_VIEW_EFFECTIVE_VALUE SettingView = 2
	// Include [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value], but nothing else.
	SettingView_SETTING_VIEW_LOCAL_VALUE SettingView = 3
)

func (SettingView) Descriptor 

func (SettingView) Descriptor() protoreflect.EnumDescriptor

func (SettingView) Enum 

func (x SettingView) Enum() *SettingView

func (SettingView) EnumDescriptor deprecated 

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

Deprecated: Use SettingView.Descriptor instead.

func (SettingView) Number 

func (x SettingView) Number() protoreflect.EnumNumber

func (SettingView) String 

func (x SettingView) String() string

func (SettingView) Type 

func (SettingView) Type() protoreflect.EnumType

type UnimplementedResourceSettingsServiceServer 

type UnimplementedResourceSettingsServiceServer struct {
}

UnimplementedResourceSettingsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedResourceSettingsServiceServer) GetSetting 

func (*UnimplementedResourceSettingsServiceServer) GetSetting(context.Context, *GetSettingRequest) (*Setting, error)

func (*UnimplementedResourceSettingsServiceServer) ListSettings 

func (*UnimplementedResourceSettingsServiceServer) ListSettings(context.Context, *ListSettingsRequest) (*ListSettingsResponse, error)

func (*UnimplementedResourceSettingsServiceServer) UpdateSetting 

func (*UnimplementedResourceSettingsServiceServer) UpdateSetting(context.Context, *UpdateSettingRequest) (*Setting, error)

type UpdateSettingRequest 

type UpdateSettingRequest struct {

	// Required. The setting to update. See [Setting][google.cloud.resourcesettings.v1.Setting] for field requirements.
	Setting *Setting `protobuf:"bytes,1,opt,name=setting,proto3" json:"setting,omitempty"`
	// contains filtered or unexported fields
}

The request for UpdateSetting.

func (*UpdateSettingRequest) Descriptor deprecated 

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

Deprecated: Use UpdateSettingRequest.ProtoReflect.Descriptor instead.

func (*UpdateSettingRequest) GetSetting 

func (x *UpdateSettingRequest) GetSetting() *Setting

func (*UpdateSettingRequest) ProtoMessage 

func (*UpdateSettingRequest) ProtoMessage()

func (*UpdateSettingRequest) ProtoReflect 

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

func (*UpdateSettingRequest) Reset 

func (x *UpdateSettingRequest) Reset()

func (*UpdateSettingRequest) String 

func (x *UpdateSettingRequest) String() string

type Value 

type Value struct {

	// Selects the data type and associated value.
	//
	// Types that are assignable to Value:
	//
	//	*Value_BooleanValue
	//	*Value_StringValue
	//	*Value_StringSetValue
	//	*Value_EnumValue_
	Value isValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

The data in a setting value.

func (*Value) Descriptor deprecated 

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

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetBooleanValue 

func (x *Value) GetBooleanValue() bool

func (*Value) GetEnumValue 

func (x *Value) GetEnumValue() *Value_EnumValue

func (*Value) GetStringSetValue 

func (x *Value) GetStringSetValue() *Value_StringSet

func (*Value) GetStringValue 

func (x *Value) GetStringValue() string

func (*Value) GetValue 

func (m *Value) GetValue() isValue_Value

func (*Value) ProtoMessage 

func (*Value) ProtoMessage()

func (*Value) ProtoReflect 

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

func (*Value) Reset 

func (x *Value) Reset()

func (*Value) String 

func (x *Value) String() string

type Value_BooleanValue 

type Value_BooleanValue struct {
	// Defines this value as being a boolean value.
	BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}

type Value_EnumValue 

type Value_EnumValue struct {

	// The value of this enum
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions.

func (*Value_EnumValue) Descriptor deprecated 

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

Deprecated: Use Value_EnumValue.ProtoReflect.Descriptor instead.

func (*Value_EnumValue) GetValue 

func (x *Value_EnumValue) GetValue() string

func (*Value_EnumValue) ProtoMessage 

func (*Value_EnumValue) ProtoMessage()

func (*Value_EnumValue) ProtoReflect 

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

func (*Value_EnumValue) Reset 

func (x *Value_EnumValue) Reset()

func (*Value_EnumValue) String 

func (x *Value_EnumValue) String() string

type Value_EnumValue_ 

type Value_EnumValue_ struct {
	// Defines this value as being a Enum.
	EnumValue *Value_EnumValue `protobuf:"bytes,4,opt,name=enum_value,json=enumValue,proto3,oneof"`
}

type Value_StringSet 

type Value_StringSet struct {

	// The strings in the set
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set.

func (*Value_StringSet) Descriptor deprecated 

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

Deprecated: Use Value_StringSet.ProtoReflect.Descriptor instead.

func (*Value_StringSet) GetValues 

func (x *Value_StringSet) GetValues() []string

func (*Value_StringSet) ProtoMessage 

func (*Value_StringSet) ProtoMessage()

func (*Value_StringSet) ProtoReflect 

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

func (*Value_StringSet) Reset 

func (x *Value_StringSet) Reset()

func (*Value_StringSet) String 

func (x *Value_StringSet) String() string

type Value_StringSetValue 

type Value_StringSetValue struct {
	// Defines this value as being a StringSet.
	StringSetValue *Value_StringSet `protobuf:"bytes,3,opt,name=string_set_value,json=stringSetValue,proto3,oneof"`
}

type Value_StringValue 

type Value_StringValue struct {
	// Defines this value as being a string value.
	StringValue string `protobuf:"bytes,2,opt,name=string_value,json=stringValue,proto3,oneof"`
}

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.