Documentation ¶
Index ¶
- Variables
- func RegisterResourceSettingsServiceServer(s *grpc.Server, srv ResourceSettingsServiceServer)
- type CreateSettingValueRequest
- func (*CreateSettingValueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateSettingValueRequest) GetParent() string
- func (x *CreateSettingValueRequest) GetSettingValue() *SettingValue
- func (*CreateSettingValueRequest) ProtoMessage()
- func (x *CreateSettingValueRequest) ProtoReflect() protoreflect.Message
- func (x *CreateSettingValueRequest) Reset()
- func (x *CreateSettingValueRequest) String() string
- type DeleteSettingValueRequest
- func (*DeleteSettingValueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteSettingValueRequest) GetName() string
- func (*DeleteSettingValueRequest) ProtoMessage()
- func (x *DeleteSettingValueRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteSettingValueRequest) Reset()
- func (x *DeleteSettingValueRequest) String() string
- type GetSettingValueRequest
- func (*GetSettingValueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetSettingValueRequest) GetName() string
- func (*GetSettingValueRequest) ProtoMessage()
- func (x *GetSettingValueRequest) ProtoReflect() protoreflect.Message
- func (x *GetSettingValueRequest) Reset()
- func (x *GetSettingValueRequest) String() string
- type ListSettingsRequest
- func (*ListSettingsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListSettingsRequest) GetPageSize() int32
- func (x *ListSettingsRequest) GetPageToken() string
- func (x *ListSettingsRequest) GetParent() string
- func (*ListSettingsRequest) ProtoMessage()
- func (x *ListSettingsRequest) ProtoReflect() protoreflect.Message
- func (x *ListSettingsRequest) Reset()
- func (x *ListSettingsRequest) String() string
- type ListSettingsResponse
- func (*ListSettingsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListSettingsResponse) GetNextPageToken() string
- func (x *ListSettingsResponse) GetSettings() []*Setting
- func (*ListSettingsResponse) ProtoMessage()
- func (x *ListSettingsResponse) ProtoReflect() protoreflect.Message
- func (x *ListSettingsResponse) Reset()
- func (x *ListSettingsResponse) String() string
- type LookupEffectiveSettingValueRequest
- func (*LookupEffectiveSettingValueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *LookupEffectiveSettingValueRequest) GetName() string
- func (*LookupEffectiveSettingValueRequest) ProtoMessage()
- func (x *LookupEffectiveSettingValueRequest) ProtoReflect() protoreflect.Message
- func (x *LookupEffectiveSettingValueRequest) Reset()
- func (x *LookupEffectiveSettingValueRequest) String() string
- type ResourceSettingsServiceClient
- type ResourceSettingsServiceServer
- type SearchSettingValuesRequest
- func (*SearchSettingValuesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SearchSettingValuesRequest) GetPageSize() int32
- func (x *SearchSettingValuesRequest) GetPageToken() string
- func (x *SearchSettingValuesRequest) GetParent() string
- func (*SearchSettingValuesRequest) ProtoMessage()
- func (x *SearchSettingValuesRequest) ProtoReflect() protoreflect.Message
- func (x *SearchSettingValuesRequest) Reset()
- func (x *SearchSettingValuesRequest) String() string
- type SearchSettingValuesResponse
- func (*SearchSettingValuesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SearchSettingValuesResponse) GetNextPageToken() string
- func (x *SearchSettingValuesResponse) GetSettingValues() []*SettingValue
- func (*SearchSettingValuesResponse) ProtoMessage()
- func (x *SearchSettingValuesResponse) ProtoReflect() protoreflect.Message
- func (x *SearchSettingValuesResponse) Reset()
- func (x *SearchSettingValuesResponse) String() string
- type Setting
- func (*Setting) Descriptor() ([]byte, []int)deprecated
- func (x *Setting) GetDataType() Setting_DataType
- func (x *Setting) GetDefaultValue() *Value
- func (x *Setting) GetDescription() string
- func (x *Setting) GetDisplayName() string
- func (x *Setting) GetName() string
- func (x *Setting) GetReadOnly() bool
- func (*Setting) ProtoMessage()
- func (x *Setting) ProtoReflect() protoreflect.Message
- func (x *Setting) Reset()
- func (x *Setting) String() string
- type SettingValue
- func (*SettingValue) Descriptor() ([]byte, []int)deprecated
- func (x *SettingValue) GetEtag() string
- func (x *SettingValue) GetName() string
- func (x *SettingValue) GetReadOnly() bool
- func (x *SettingValue) GetUpdateTime() *timestamppb.Timestamp
- func (x *SettingValue) GetValue() *Value
- func (*SettingValue) ProtoMessage()
- func (x *SettingValue) ProtoReflect() protoreflect.Message
- func (x *SettingValue) Reset()
- func (x *SettingValue) String() string
- type Setting_DataType
- func (Setting_DataType) Descriptor() protoreflect.EnumDescriptor
- func (x Setting_DataType) Enum() *Setting_DataType
- func (Setting_DataType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Setting_DataType) Number() protoreflect.EnumNumber
- func (x Setting_DataType) String() string
- func (Setting_DataType) Type() protoreflect.EnumType
- type UnimplementedResourceSettingsServiceServer
- func (*UnimplementedResourceSettingsServiceServer) CreateSettingValue(context.Context, *CreateSettingValueRequest) (*SettingValue, error)
- func (*UnimplementedResourceSettingsServiceServer) DeleteSettingValue(context.Context, *DeleteSettingValueRequest) (*emptypb.Empty, error)
- func (*UnimplementedResourceSettingsServiceServer) GetSettingValue(context.Context, *GetSettingValueRequest) (*SettingValue, error)
- func (*UnimplementedResourceSettingsServiceServer) ListSettings(context.Context, *ListSettingsRequest) (*ListSettingsResponse, error)
- func (*UnimplementedResourceSettingsServiceServer) LookupEffectiveSettingValue(context.Context, *LookupEffectiveSettingValueRequest) (*SettingValue, error)
- func (*UnimplementedResourceSettingsServiceServer) SearchSettingValues(context.Context, *SearchSettingValuesRequest) (*SearchSettingValuesResponse, error)
- func (*UnimplementedResourceSettingsServiceServer) UpdateSettingValue(context.Context, *UpdateSettingValueRequest) (*SettingValue, error)
- type UpdateSettingValueRequest
- func (*UpdateSettingValueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateSettingValueRequest) GetSettingValue() *SettingValue
- func (*UpdateSettingValueRequest) ProtoMessage()
- func (x *UpdateSettingValueRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateSettingValueRequest) Reset()
- func (x *UpdateSettingValueRequest) String() string
- type Value
- func (*Value) Descriptor() ([]byte, []int)deprecated
- func (x *Value) GetBooleanValue() bool
- func (x *Value) GetEnumValue() *Value_EnumValue
- func (x *Value) GetStringSetValue() *Value_StringSet
- func (x *Value) GetStringValue() string
- func (m *Value) GetValue() isValue_Value
- func (*Value) ProtoMessage()
- func (x *Value) ProtoReflect() protoreflect.Message
- func (x *Value) Reset()
- func (x *Value) String() string
- type Value_BooleanValue
- type Value_EnumValue
- type Value_EnumValue_
- type Value_StringSet
- type Value_StringSetValue
- type Value_StringValue
Constants ¶
This section is empty.
Variables ¶
var ( Setting_DataType_name = map[int32]string{ 0: "DATA_TYPE_UNSPECIFIED", 1: "BOOLEAN", 2: "STRING", 3: "STRING_SET", 4: "ENUM_VALUE", } Setting_DataType_value = map[string]int32{ "DATA_TYPE_UNSPECIFIED": 0, "BOOLEAN": 1, "STRING": 2, "STRING_SET": 3, "ENUM_VALUE": 4, } )
Enum value maps for Setting_DataType.
var File_google_cloud_resourcesettings_v1_resource_settings_proto protoreflect.FileDescriptor
Functions ¶
func RegisterResourceSettingsServiceServer ¶
func RegisterResourceSettingsServiceServer(s *grpc.Server, srv ResourceSettingsServiceServer)
Types ¶
type CreateSettingValueRequest ¶
type CreateSettingValueRequest struct { // Required. The name of the setting for which a value should be created. // See [Setting][google.cloud.resourcesettings.v1.Setting] for naming requirements. Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // Required. The setting value to create. See [SettingValue][google.cloud.resourcesettings.v1.SettingValue] for field requirements. SettingValue *SettingValue `protobuf:"bytes,2,opt,name=setting_value,json=settingValue,proto3" json:"setting_value,omitempty"` // contains filtered or unexported fields }
The request for CreateSettingValue.
func (*CreateSettingValueRequest) Descriptor
deprecated
func (*CreateSettingValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSettingValueRequest.ProtoReflect.Descriptor instead.
func (*CreateSettingValueRequest) GetParent ¶
func (x *CreateSettingValueRequest) GetParent() string
func (*CreateSettingValueRequest) GetSettingValue ¶
func (x *CreateSettingValueRequest) GetSettingValue() *SettingValue
func (*CreateSettingValueRequest) ProtoMessage ¶
func (*CreateSettingValueRequest) ProtoMessage()
func (*CreateSettingValueRequest) ProtoReflect ¶
func (x *CreateSettingValueRequest) ProtoReflect() protoreflect.Message
func (*CreateSettingValueRequest) Reset ¶
func (x *CreateSettingValueRequest) Reset()
func (*CreateSettingValueRequest) String ¶
func (x *CreateSettingValueRequest) String() string
type DeleteSettingValueRequest ¶
type DeleteSettingValueRequest struct { // Required. The name of the setting value to delete. See [SettingValue][google.cloud.resourcesettings.v1.SettingValue] for naming // requirements. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The request for DeleteSettingValue.
func (*DeleteSettingValueRequest) Descriptor
deprecated
func (*DeleteSettingValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSettingValueRequest.ProtoReflect.Descriptor instead.
func (*DeleteSettingValueRequest) GetName ¶
func (x *DeleteSettingValueRequest) GetName() string
func (*DeleteSettingValueRequest) ProtoMessage ¶
func (*DeleteSettingValueRequest) ProtoMessage()
func (*DeleteSettingValueRequest) ProtoReflect ¶
func (x *DeleteSettingValueRequest) ProtoReflect() protoreflect.Message
func (*DeleteSettingValueRequest) Reset ¶
func (x *DeleteSettingValueRequest) Reset()
func (*DeleteSettingValueRequest) String ¶
func (x *DeleteSettingValueRequest) String() string
type GetSettingValueRequest ¶
type GetSettingValueRequest struct { // Required. The name of the setting value to get. See [SettingValue][google.cloud.resourcesettings.v1.SettingValue] for naming // requirements. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The request for GetSettingValue.
func (*GetSettingValueRequest) Descriptor
deprecated
func (*GetSettingValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSettingValueRequest.ProtoReflect.Descriptor instead.
func (*GetSettingValueRequest) GetName ¶
func (x *GetSettingValueRequest) GetName() string
func (*GetSettingValueRequest) ProtoMessage ¶
func (*GetSettingValueRequest) ProtoMessage()
func (*GetSettingValueRequest) ProtoReflect ¶
func (x *GetSettingValueRequest) ProtoReflect() protoreflect.Message
func (*GetSettingValueRequest) Reset ¶
func (x *GetSettingValueRequest) Reset()
func (*GetSettingValueRequest) String ¶
func (x *GetSettingValueRequest) 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"` // 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) 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 LookupEffectiveSettingValueRequest ¶
type LookupEffectiveSettingValueRequest struct { // Required. The setting value for which an effective value will be evaluated. // See [SettingValue][google.cloud.resourcesettings.v1.SettingValue] for naming requirements. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
The request for LookupEffectiveSettingValue.
func (*LookupEffectiveSettingValueRequest) Descriptor
deprecated
func (*LookupEffectiveSettingValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use LookupEffectiveSettingValueRequest.ProtoReflect.Descriptor instead.
func (*LookupEffectiveSettingValueRequest) GetName ¶
func (x *LookupEffectiveSettingValueRequest) GetName() string
func (*LookupEffectiveSettingValueRequest) ProtoMessage ¶
func (*LookupEffectiveSettingValueRequest) ProtoMessage()
func (*LookupEffectiveSettingValueRequest) ProtoReflect ¶
func (x *LookupEffectiveSettingValueRequest) ProtoReflect() protoreflect.Message
func (*LookupEffectiveSettingValueRequest) Reset ¶
func (x *LookupEffectiveSettingValueRequest) Reset()
func (*LookupEffectiveSettingValueRequest) String ¶
func (x *LookupEffectiveSettingValueRequest) 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) // Searches for all setting values that exist on the resource `parent`. The // setting values are not limited to those of a particular setting. SearchSettingValues(ctx context.Context, in *SearchSettingValuesRequest, opts ...grpc.CallOption) (*SearchSettingValuesResponse, error) // Gets a setting value. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting value does not exist. GetSettingValue(ctx context.Context, in *GetSettingValueRequest, opts ...grpc.CallOption) (*SettingValue, error) // Computes the effective setting value of a setting at the Cloud resource // `parent`. The effective setting value is the calculated setting value at a // Cloud resource and 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 setting value on the given resource // 2. the setting value on the given resource's nearest ancestor // 3. the setting's default value // 4. an empty setting value, defined as a `SettingValue` with all fields // unset // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting does not exist. LookupEffectiveSettingValue(ctx context.Context, in *LookupEffectiveSettingValueRequest, opts ...grpc.CallOption) (*SettingValue, error) // Creates a setting value. // // 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.ALREADY_EXISTS` if the // setting value already exists on the given Cloud resource. // Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if // the setting is flagged as read only. CreateSettingValue(ctx context.Context, in *CreateSettingValueRequest, opts ...grpc.CallOption) (*SettingValue, error) // Updates a setting value. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting or the setting value 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. // // Note: the supplied setting value will perform a full overwrite of all // fields. UpdateSettingValue(ctx context.Context, in *UpdateSettingValueRequest, opts ...grpc.CallOption) (*SettingValue, error) // Deletes a setting value. If the setting value does not exist, the operation // is a no-op. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting or the setting value does not exist. The setting value will not // exist if a prior call to `DeleteSettingValue` for the setting value already // returned a success code. // Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if // the setting is flagged as read only. DeleteSettingValue(ctx context.Context, in *DeleteSettingValueRequest, opts ...grpc.CallOption) (*emptypb.Empty, 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) // Searches for all setting values that exist on the resource `parent`. The // setting values are not limited to those of a particular setting. SearchSettingValues(context.Context, *SearchSettingValuesRequest) (*SearchSettingValuesResponse, error) // Gets a setting value. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting value does not exist. GetSettingValue(context.Context, *GetSettingValueRequest) (*SettingValue, error) // Computes the effective setting value of a setting at the Cloud resource // `parent`. The effective setting value is the calculated setting value at a // Cloud resource and 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 setting value on the given resource // 2. the setting value on the given resource's nearest ancestor // 3. the setting's default value // 4. an empty setting value, defined as a `SettingValue` with all fields // unset // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting does not exist. LookupEffectiveSettingValue(context.Context, *LookupEffectiveSettingValueRequest) (*SettingValue, error) // Creates a setting value. // // 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.ALREADY_EXISTS` if the // setting value already exists on the given Cloud resource. // Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if // the setting is flagged as read only. CreateSettingValue(context.Context, *CreateSettingValueRequest) (*SettingValue, error) // Updates a setting value. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting or the setting value 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. // // Note: the supplied setting value will perform a full overwrite of all // fields. UpdateSettingValue(context.Context, *UpdateSettingValueRequest) (*SettingValue, error) // Deletes a setting value. If the setting value does not exist, the operation // is a no-op. // // Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the // setting or the setting value does not exist. The setting value will not // exist if a prior call to `DeleteSettingValue` for the setting value already // returned a success code. // Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if // the setting is flagged as read only. DeleteSettingValue(context.Context, *DeleteSettingValueRequest) (*emptypb.Empty, error) }
ResourceSettingsServiceServer is the server API for ResourceSettingsService service.
type SearchSettingValuesRequest ¶
type SearchSettingValuesRequest 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"` // contains filtered or unexported fields }
The request for SearchSettingValues.
func (*SearchSettingValuesRequest) Descriptor
deprecated
func (*SearchSettingValuesRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchSettingValuesRequest.ProtoReflect.Descriptor instead.
func (*SearchSettingValuesRequest) GetPageSize ¶
func (x *SearchSettingValuesRequest) GetPageSize() int32
func (*SearchSettingValuesRequest) GetPageToken ¶
func (x *SearchSettingValuesRequest) GetPageToken() string
func (*SearchSettingValuesRequest) GetParent ¶
func (x *SearchSettingValuesRequest) GetParent() string
func (*SearchSettingValuesRequest) ProtoMessage ¶
func (*SearchSettingValuesRequest) ProtoMessage()
func (*SearchSettingValuesRequest) ProtoReflect ¶
func (x *SearchSettingValuesRequest) ProtoReflect() protoreflect.Message
func (*SearchSettingValuesRequest) Reset ¶
func (x *SearchSettingValuesRequest) Reset()
func (*SearchSettingValuesRequest) String ¶
func (x *SearchSettingValuesRequest) String() string
type SearchSettingValuesResponse ¶
type SearchSettingValuesResponse struct { // All setting values that exist on the specified Cloud resource. SettingValues []*SettingValue `protobuf:"bytes,1,rep,name=setting_values,json=settingValues,proto3" json:"setting_values,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 SearchSettingValues.
func (*SearchSettingValuesResponse) Descriptor
deprecated
func (*SearchSettingValuesResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchSettingValuesResponse.ProtoReflect.Descriptor instead.
func (*SearchSettingValuesResponse) GetNextPageToken ¶
func (x *SearchSettingValuesResponse) GetNextPageToken() string
func (*SearchSettingValuesResponse) GetSettingValues ¶
func (x *SearchSettingValuesResponse) GetSettingValues() []*SettingValue
func (*SearchSettingValuesResponse) ProtoMessage ¶
func (*SearchSettingValuesResponse) ProtoMessage()
func (*SearchSettingValuesResponse) ProtoReflect ¶
func (x *SearchSettingValuesResponse) ProtoReflect() protoreflect.Message
func (*SearchSettingValuesResponse) Reset ¶
func (x *SearchSettingValuesResponse) Reset()
func (*SearchSettingValuesResponse) String ¶
func (x *SearchSettingValuesResponse) String() string
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"` // The human readable name for this setting. DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` // A detailed description of what this setting does. Description string `protobuf:"bytes,3,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,4,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"` // The data type for this setting. DataType Setting_DataType `` /* 141-byte string literal not displayed */ // The value received by // [LookupEffectiveSettingValue][google.cloud.resourcesettings.v1.ResourceSettingsService.LookupEffectiveSettingValue] // if no setting value is explicitly set. // // Note: not all settings have a default value. DefaultValue *Value `protobuf:"bytes,6,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // contains filtered or unexported fields }
The schema for setting values. At a given Cloud resource, a setting can parent at most one setting value.
func (*Setting) Descriptor
deprecated
func (*Setting) GetDataType ¶
func (x *Setting) GetDataType() Setting_DataType
func (*Setting) GetDefaultValue ¶
func (*Setting) GetDescription ¶
func (*Setting) GetDisplayName ¶
func (*Setting) GetReadOnly ¶
func (*Setting) ProtoMessage ¶
func (*Setting) ProtoMessage()
func (*Setting) ProtoReflect ¶
func (x *Setting) ProtoReflect() protoreflect.Message
type SettingValue ¶
type SettingValue struct { // The resource name of the setting value. Must be in one of the following // forms: // // * `projects/{project_number}/settings/{setting_name}/value` // * `folders/{folder_id}/settings/{setting_name}/value` // * `organizations/{organization_id}/settings/{setting_name}/value` // // For example, "/projects/123/settings/gcp-enableMyFeature/value" Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The value of the setting. The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be // consistent with the data type defined by the parent setting. Value *Value `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // A fingerprint used for optimistic concurrency. See // [UpdateSettingValue][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSettingValue] for more // details. Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"` // Output only. A flag indicating that this setting value cannot be modified. // This flag is inherited from its parent setting and is for // convenience purposes. See [Setting.read_only][google.cloud.resourcesettings.v1.Setting.read_only] for more details. ReadOnly bool `protobuf:"varint,4,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"` // Output only. The timestamp indicating when the setting value was last // updated. UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"` // contains filtered or unexported fields }
The instantiation of a setting. Every setting value is parented by its corresponding setting.
func (*SettingValue) Descriptor
deprecated
func (*SettingValue) Descriptor() ([]byte, []int)
Deprecated: Use SettingValue.ProtoReflect.Descriptor instead.
func (*SettingValue) GetEtag ¶
func (x *SettingValue) GetEtag() string
func (*SettingValue) GetName ¶
func (x *SettingValue) GetName() string
func (*SettingValue) GetReadOnly ¶
func (x *SettingValue) GetReadOnly() bool
func (*SettingValue) GetUpdateTime ¶
func (x *SettingValue) GetUpdateTime() *timestamppb.Timestamp
func (*SettingValue) GetValue ¶
func (x *SettingValue) GetValue() *Value
func (*SettingValue) ProtoMessage ¶
func (*SettingValue) ProtoMessage()
func (*SettingValue) ProtoReflect ¶
func (x *SettingValue) ProtoReflect() protoreflect.Message
func (*SettingValue) Reset ¶
func (x *SettingValue) Reset()
func (*SettingValue) String ¶
func (x *SettingValue) String() string
type Setting_DataType ¶
type Setting_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. Setting_DATA_TYPE_UNSPECIFIED Setting_DataType = 0 // A boolean setting. Setting_BOOLEAN Setting_DataType = 1 // A string setting. Setting_STRING Setting_DataType = 2 // A string set setting. Setting_STRING_SET Setting_DataType = 3 // A Enum setting Setting_ENUM_VALUE Setting_DataType = 4 )
func (Setting_DataType) Descriptor ¶
func (Setting_DataType) Descriptor() protoreflect.EnumDescriptor
func (Setting_DataType) Enum ¶
func (x Setting_DataType) Enum() *Setting_DataType
func (Setting_DataType) EnumDescriptor
deprecated
func (Setting_DataType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Setting_DataType.Descriptor instead.
func (Setting_DataType) Number ¶
func (x Setting_DataType) Number() protoreflect.EnumNumber
func (Setting_DataType) String ¶
func (x Setting_DataType) String() string
func (Setting_DataType) Type ¶
func (Setting_DataType) Type() protoreflect.EnumType
type UnimplementedResourceSettingsServiceServer ¶
type UnimplementedResourceSettingsServiceServer struct { }
UnimplementedResourceSettingsServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedResourceSettingsServiceServer) CreateSettingValue ¶
func (*UnimplementedResourceSettingsServiceServer) CreateSettingValue(context.Context, *CreateSettingValueRequest) (*SettingValue, error)
func (*UnimplementedResourceSettingsServiceServer) DeleteSettingValue ¶
func (*UnimplementedResourceSettingsServiceServer) DeleteSettingValue(context.Context, *DeleteSettingValueRequest) (*emptypb.Empty, error)
func (*UnimplementedResourceSettingsServiceServer) GetSettingValue ¶
func (*UnimplementedResourceSettingsServiceServer) GetSettingValue(context.Context, *GetSettingValueRequest) (*SettingValue, error)
func (*UnimplementedResourceSettingsServiceServer) ListSettings ¶
func (*UnimplementedResourceSettingsServiceServer) ListSettings(context.Context, *ListSettingsRequest) (*ListSettingsResponse, error)
func (*UnimplementedResourceSettingsServiceServer) LookupEffectiveSettingValue ¶
func (*UnimplementedResourceSettingsServiceServer) LookupEffectiveSettingValue(context.Context, *LookupEffectiveSettingValueRequest) (*SettingValue, error)
func (*UnimplementedResourceSettingsServiceServer) SearchSettingValues ¶
func (*UnimplementedResourceSettingsServiceServer) SearchSettingValues(context.Context, *SearchSettingValuesRequest) (*SearchSettingValuesResponse, error)
func (*UnimplementedResourceSettingsServiceServer) UpdateSettingValue ¶
func (*UnimplementedResourceSettingsServiceServer) UpdateSettingValue(context.Context, *UpdateSettingValueRequest) (*SettingValue, error)
type UpdateSettingValueRequest ¶
type UpdateSettingValueRequest struct { // Required. The setting value to update. See [SettingValue][google.cloud.resourcesettings.v1.SettingValue] for field requirements. SettingValue *SettingValue `protobuf:"bytes,1,opt,name=setting_value,json=settingValue,proto3" json:"setting_value,omitempty"` // contains filtered or unexported fields }
The request for UpdateSettingValue.
func (*UpdateSettingValueRequest) Descriptor
deprecated
func (*UpdateSettingValueRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSettingValueRequest.ProtoReflect.Descriptor instead.
func (*UpdateSettingValueRequest) GetSettingValue ¶
func (x *UpdateSettingValueRequest) GetSettingValue() *SettingValue
func (*UpdateSettingValueRequest) ProtoMessage ¶
func (*UpdateSettingValueRequest) ProtoMessage()
func (*UpdateSettingValueRequest) ProtoReflect ¶
func (x *UpdateSettingValueRequest) ProtoReflect() protoreflect.Message
func (*UpdateSettingValueRequest) Reset ¶
func (x *UpdateSettingValueRequest) Reset()
func (*UpdateSettingValueRequest) String ¶
func (x *UpdateSettingValueRequest) 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) GetBooleanValue ¶
func (*Value) GetEnumValue ¶
func (x *Value) GetEnumValue() *Value_EnumValue
func (*Value) GetStringSetValue ¶
func (x *Value) GetStringSetValue() *Value_StringSet
func (*Value) GetStringValue ¶
func (*Value) ProtoMessage ¶
func (*Value) ProtoMessage()
func (*Value) ProtoReflect ¶
func (x *Value) ProtoReflect() protoreflect.Message
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 { 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 60 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"` }