...

Package resourcesettings

import "google.golang.org/api/resourcesettings/v1"
Overview
Index

Overview ▾

Package resourcesettings provides access to the Resource Settings API.

For product documentation, see: https://cloud.google.com/resource-manager/docs/resource-settings/overview

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/resourcesettings/v1"
...
ctx := context.Background()
resourcesettingsService, err := resourcesettings.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

resourcesettingsService, err := resourcesettings.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
resourcesettingsService, err := resourcesettings.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index ▾

Constants
type FoldersService
    func NewFoldersService(s *Service) *FoldersService
type FoldersSettingsGetCall
    func (c *FoldersSettingsGetCall) Context(ctx context.Context) *FoldersSettingsGetCall
    func (c *FoldersSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *FoldersSettingsGetCall) Fields(s ...googleapi.Field) *FoldersSettingsGetCall
    func (c *FoldersSettingsGetCall) Header() http.Header
    func (c *FoldersSettingsGetCall) IfNoneMatch(entityTag string) *FoldersSettingsGetCall
    func (c *FoldersSettingsGetCall) View(view string) *FoldersSettingsGetCall
type FoldersSettingsListCall
    func (c *FoldersSettingsListCall) Context(ctx context.Context) *FoldersSettingsListCall
    func (c *FoldersSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)
    func (c *FoldersSettingsListCall) Fields(s ...googleapi.Field) *FoldersSettingsListCall
    func (c *FoldersSettingsListCall) Header() http.Header
    func (c *FoldersSettingsListCall) IfNoneMatch(entityTag string) *FoldersSettingsListCall
    func (c *FoldersSettingsListCall) PageSize(pageSize int64) *FoldersSettingsListCall
    func (c *FoldersSettingsListCall) PageToken(pageToken string) *FoldersSettingsListCall
    func (c *FoldersSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error
    func (c *FoldersSettingsListCall) View(view string) *FoldersSettingsListCall
type FoldersSettingsPatchCall
    func (c *FoldersSettingsPatchCall) Context(ctx context.Context) *FoldersSettingsPatchCall
    func (c *FoldersSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *FoldersSettingsPatchCall) Fields(s ...googleapi.Field) *FoldersSettingsPatchCall
    func (c *FoldersSettingsPatchCall) Header() http.Header
type FoldersSettingsService
    func NewFoldersSettingsService(s *Service) *FoldersSettingsService
    func (r *FoldersSettingsService) Get(name string) *FoldersSettingsGetCall
    func (r *FoldersSettingsService) List(parent string) *FoldersSettingsListCall
    func (r *FoldersSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *FoldersSettingsPatchCall
type GoogleCloudResourcesettingsV1ListSettingsResponse
    func (s *GoogleCloudResourcesettingsV1ListSettingsResponse) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1Setting
    func (s *GoogleCloudResourcesettingsV1Setting) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1SettingMetadata
    func (s *GoogleCloudResourcesettingsV1SettingMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1Value
    func (s *GoogleCloudResourcesettingsV1Value) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1ValueEnumValue
    func (s *GoogleCloudResourcesettingsV1ValueEnumValue) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1ValueStringMap
    func (s *GoogleCloudResourcesettingsV1ValueStringMap) MarshalJSON() ([]byte, error)
type GoogleCloudResourcesettingsV1ValueStringSet
    func (s *GoogleCloudResourcesettingsV1ValueStringSet) MarshalJSON() ([]byte, error)
type OrganizationsService
    func NewOrganizationsService(s *Service) *OrganizationsService
type OrganizationsSettingsGetCall
    func (c *OrganizationsSettingsGetCall) Context(ctx context.Context) *OrganizationsSettingsGetCall
    func (c *OrganizationsSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *OrganizationsSettingsGetCall) Fields(s ...googleapi.Field) *OrganizationsSettingsGetCall
    func (c *OrganizationsSettingsGetCall) Header() http.Header
    func (c *OrganizationsSettingsGetCall) IfNoneMatch(entityTag string) *OrganizationsSettingsGetCall
    func (c *OrganizationsSettingsGetCall) View(view string) *OrganizationsSettingsGetCall
type OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) Context(ctx context.Context) *OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)
    func (c *OrganizationsSettingsListCall) Fields(s ...googleapi.Field) *OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) Header() http.Header
    func (c *OrganizationsSettingsListCall) IfNoneMatch(entityTag string) *OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) PageSize(pageSize int64) *OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) PageToken(pageToken string) *OrganizationsSettingsListCall
    func (c *OrganizationsSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error
    func (c *OrganizationsSettingsListCall) View(view string) *OrganizationsSettingsListCall
type OrganizationsSettingsPatchCall
    func (c *OrganizationsSettingsPatchCall) Context(ctx context.Context) *OrganizationsSettingsPatchCall
    func (c *OrganizationsSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *OrganizationsSettingsPatchCall) Fields(s ...googleapi.Field) *OrganizationsSettingsPatchCall
    func (c *OrganizationsSettingsPatchCall) Header() http.Header
type OrganizationsSettingsService
    func NewOrganizationsSettingsService(s *Service) *OrganizationsSettingsService
    func (r *OrganizationsSettingsService) Get(name string) *OrganizationsSettingsGetCall
    func (r *OrganizationsSettingsService) List(parent string) *OrganizationsSettingsListCall
    func (r *OrganizationsSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *OrganizationsSettingsPatchCall
type ProjectsService
    func NewProjectsService(s *Service) *ProjectsService
type ProjectsSettingsGetCall
    func (c *ProjectsSettingsGetCall) Context(ctx context.Context) *ProjectsSettingsGetCall
    func (c *ProjectsSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *ProjectsSettingsGetCall) Fields(s ...googleapi.Field) *ProjectsSettingsGetCall
    func (c *ProjectsSettingsGetCall) Header() http.Header
    func (c *ProjectsSettingsGetCall) IfNoneMatch(entityTag string) *ProjectsSettingsGetCall
    func (c *ProjectsSettingsGetCall) View(view string) *ProjectsSettingsGetCall
type ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) Context(ctx context.Context) *ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)
    func (c *ProjectsSettingsListCall) Fields(s ...googleapi.Field) *ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) Header() http.Header
    func (c *ProjectsSettingsListCall) IfNoneMatch(entityTag string) *ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) PageSize(pageSize int64) *ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) PageToken(pageToken string) *ProjectsSettingsListCall
    func (c *ProjectsSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error
    func (c *ProjectsSettingsListCall) View(view string) *ProjectsSettingsListCall
type ProjectsSettingsPatchCall
    func (c *ProjectsSettingsPatchCall) Context(ctx context.Context) *ProjectsSettingsPatchCall
    func (c *ProjectsSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)
    func (c *ProjectsSettingsPatchCall) Fields(s ...googleapi.Field) *ProjectsSettingsPatchCall
    func (c *ProjectsSettingsPatchCall) Header() http.Header
type ProjectsSettingsService
    func NewProjectsSettingsService(s *Service) *ProjectsSettingsService
    func (r *ProjectsSettingsService) Get(name string) *ProjectsSettingsGetCall
    func (r *ProjectsSettingsService) List(parent string) *ProjectsSettingsListCall
    func (r *ProjectsSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *ProjectsSettingsPatchCall
type Service
    func New(client *http.Client) (*Service, error)
    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Package files

resourcesettings-gen.go

Constants

OAuth2 scopes used by this API.

const (
    // See, edit, configure, and delete your Google Cloud data and see the email
    // address for your Google Account.
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

type FoldersService

type FoldersService struct {
    Settings *FoldersSettingsService
    // contains filtered or unexported fields
}

func NewFoldersService

func NewFoldersService(s *Service) *FoldersService

type FoldersSettingsGetCall

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

func (*FoldersSettingsGetCall) Context

func (c *FoldersSettingsGetCall) Context(ctx context.Context) *FoldersSettingsGetCall

Context sets the context to be used in this call's Do method.

func (*FoldersSettingsGetCall) Do

func (c *FoldersSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.folders.settings.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersSettingsGetCall) Fields

func (c *FoldersSettingsGetCall) Fields(s ...googleapi.Field) *FoldersSettingsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersSettingsGetCall) Header

func (c *FoldersSettingsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersSettingsGetCall) IfNoneMatch

func (c *FoldersSettingsGetCall) IfNoneMatch(entityTag string) *FoldersSettingsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersSettingsGetCall) View

func (c *FoldersSettingsGetCall) View(view string) *FoldersSettingsGetCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type FoldersSettingsListCall

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

func (*FoldersSettingsListCall) Context

func (c *FoldersSettingsListCall) Context(ctx context.Context) *FoldersSettingsListCall

Context sets the context to be used in this call's Do method.

func (*FoldersSettingsListCall) Do

func (c *FoldersSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)

Do executes the "resourcesettings.folders.settings.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1ListSettingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersSettingsListCall) Fields

func (c *FoldersSettingsListCall) Fields(s ...googleapi.Field) *FoldersSettingsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersSettingsListCall) Header

func (c *FoldersSettingsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersSettingsListCall) IfNoneMatch

func (c *FoldersSettingsListCall) IfNoneMatch(entityTag string) *FoldersSettingsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersSettingsListCall) PageSize

func (c *FoldersSettingsListCall) PageSize(pageSize int64) *FoldersSettingsListCall

PageSize sets the optional parameter "pageSize": Unused. The size of the page to be returned.

func (*FoldersSettingsListCall) PageToken

func (c *FoldersSettingsListCall) PageToken(pageToken string) *FoldersSettingsListCall

PageToken sets the optional parameter "pageToken": Unused. A page token used to retrieve the next page.

func (*FoldersSettingsListCall) Pages

func (c *FoldersSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*FoldersSettingsListCall) View

func (c *FoldersSettingsListCall) View(view string) *FoldersSettingsListCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type FoldersSettingsPatchCall

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

func (*FoldersSettingsPatchCall) Context

func (c *FoldersSettingsPatchCall) Context(ctx context.Context) *FoldersSettingsPatchCall

Context sets the context to be used in this call's Do method.

func (*FoldersSettingsPatchCall) Do

func (c *FoldersSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.folders.settings.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersSettingsPatchCall) Fields

func (c *FoldersSettingsPatchCall) Fields(s ...googleapi.Field) *FoldersSettingsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersSettingsPatchCall) Header

func (c *FoldersSettingsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersSettingsService

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

func NewFoldersSettingsService

func NewFoldersSettingsService(s *Service) *FoldersSettingsService

func (*FoldersSettingsService) Get

func (r *FoldersSettingsService) Get(name string) *FoldersSettingsGetCall

Get: Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

- name: The name of the setting to get. See Setting for naming requirements.

func (*FoldersSettingsService) List

func (r *FoldersSettingsService) List(parent string) *FoldersSettingsListCall

List: Lists all the settings that are available on the Cloud resource `parent`.

func (*FoldersSettingsService) Patch

func (r *FoldersSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *FoldersSettingsPatchCall

Patch: Updates a specified 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.

type GoogleCloudResourcesettingsV1ListSettingsResponse

GoogleCloudResourcesettingsV1ListSettingsResponse: The response from ListSettings.

type GoogleCloudResourcesettingsV1ListSettingsResponse struct {
    // NextPageToken: Unused. A page token used to retrieve the next page.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // Settings: A list of settings that are available at the specified Cloud
    // resource.
    Settings []*GoogleCloudResourcesettingsV1Setting `json:"settings,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "NextPageToken") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1ListSettingsResponse) MarshalJSON

func (s *GoogleCloudResourcesettingsV1ListSettingsResponse) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1Setting

GoogleCloudResourcesettingsV1Setting: The schema for settings.

type GoogleCloudResourcesettingsV1Setting struct {
    // EffectiveValue: Output only. The effective value of the setting at the given
    // parent resource, evaluated based on the resource hierarchy The effective
    // value evaluates to one of the following options, in this order. If an option
    // is not valid or doesn't exist, then the next option is used: 1. The local
    // setting value on the given resource: Setting.local_value 2. If one of the
    // given resource's ancestors in the resource hierarchy have a local setting
    // value, the local value at the nearest such ancestor. 3. The setting's
    // default value: SettingMetadata.default_value 4. An empty value, defined as a
    // `Value` with all fields unset. The data type of Value must always be
    // consistent with the data type defined in Setting.metadata.
    EffectiveValue *GoogleCloudResourcesettingsV1Value `json:"effectiveValue,omitempty"`
    // Etag: A fingerprint used for optimistic concurrency. See UpdateSetting for
    // more details.
    Etag string `json:"etag,omitempty"`
    // LocalValue: The configured value of the setting at the given parent
    // resource, ignoring the resource hierarchy. The data type of Value must
    // always be consistent with the data type defined in Setting.metadata.
    LocalValue *GoogleCloudResourcesettingsV1Value `json:"localValue,omitempty"`
    // Metadata: Output only. Metadata about a setting which is not editable by the
    // end user.
    Metadata *GoogleCloudResourcesettingsV1SettingMetadata `json:"metadata,omitempty"`
    // Name: 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 `json:"name,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "EffectiveValue") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "EffectiveValue") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1Setting) MarshalJSON

func (s *GoogleCloudResourcesettingsV1Setting) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1SettingMetadata

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

type GoogleCloudResourcesettingsV1SettingMetadata struct {
    // DataType: The data type for this setting.
    //
    // Possible values:
    //   "DATA_TYPE_UNSPECIFIED" - Unspecified data type.
    //   "BOOLEAN" - A boolean setting.
    //   "STRING" - A string setting.
    //   "STRING_SET" - A string set setting.
    //   "ENUM_VALUE" - A Enum setting
    //   "DURATION_VALUE" - A Duration setting
    //   "STRING_MAP" - A string->string map setting
    DataType string `json:"dataType,omitempty"`
    // DefaultValue: The value provided by Setting.effective_value if no setting
    // value is explicitly set. Note: not all settings have a default value.
    DefaultValue *GoogleCloudResourcesettingsV1Value `json:"defaultValue,omitempty"`
    // Description: A detailed description of what this setting does.
    Description string `json:"description,omitempty"`
    // DisplayName: The human readable name for this setting.
    DisplayName string `json:"displayName,omitempty"`
    // ReadOnly: A flag indicating that values of this setting cannot be modified.
    // See documentation for the specific setting for updates and reasons.
    ReadOnly bool `json:"readOnly,omitempty"`
    // ForceSendFields is a list of field names (e.g. "DataType") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "DataType") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1SettingMetadata) MarshalJSON

func (s *GoogleCloudResourcesettingsV1SettingMetadata) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1Value

GoogleCloudResourcesettingsV1Value: The data in a setting value.

type GoogleCloudResourcesettingsV1Value struct {
    // BooleanValue: Defines this value as being a boolean value.
    BooleanValue bool `json:"booleanValue,omitempty"`
    // DurationValue: Defines this value as being a Duration.
    DurationValue string `json:"durationValue,omitempty"`
    // EnumValue: Defines this value as being a Enum.
    EnumValue *GoogleCloudResourcesettingsV1ValueEnumValue `json:"enumValue,omitempty"`
    // StringMapValue: Defines this value as being a StringMap.
    StringMapValue *GoogleCloudResourcesettingsV1ValueStringMap `json:"stringMapValue,omitempty"`
    // StringSetValue: Defines this value as being a StringSet.
    StringSetValue *GoogleCloudResourcesettingsV1ValueStringSet `json:"stringSetValue,omitempty"`
    // StringValue: Defines this value as being a string value.
    StringValue string `json:"stringValue,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BooleanValue") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BooleanValue") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1Value) MarshalJSON

func (s *GoogleCloudResourcesettingsV1Value) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1ValueEnumValue

GoogleCloudResourcesettingsV1ValueEnumValue: 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.

type GoogleCloudResourcesettingsV1ValueEnumValue struct {
    // Value: The value of this enum
    Value string `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Value") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Value") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1ValueEnumValue) MarshalJSON

func (s *GoogleCloudResourcesettingsV1ValueEnumValue) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1ValueStringMap

GoogleCloudResourcesettingsV1ValueStringMap: A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map.

type GoogleCloudResourcesettingsV1ValueStringMap struct {
    // Mappings: The key-value pairs in the map
    Mappings map[string]string `json:"mappings,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Mappings") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Mappings") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1ValueStringMap) MarshalJSON

func (s *GoogleCloudResourcesettingsV1ValueStringMap) MarshalJSON() ([]byte, error)

type GoogleCloudResourcesettingsV1ValueStringSet

GoogleCloudResourcesettingsV1ValueStringSet: 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.

type GoogleCloudResourcesettingsV1ValueStringSet struct {
    // Values: The strings in the set
    Values []string `json:"values,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Values") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Values") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GoogleCloudResourcesettingsV1ValueStringSet) MarshalJSON

func (s *GoogleCloudResourcesettingsV1ValueStringSet) MarshalJSON() ([]byte, error)

type OrganizationsService

type OrganizationsService struct {
    Settings *OrganizationsSettingsService
    // contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

type OrganizationsSettingsGetCall

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

func (*OrganizationsSettingsGetCall) Context

func (c *OrganizationsSettingsGetCall) Context(ctx context.Context) *OrganizationsSettingsGetCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsSettingsGetCall) Do

func (c *OrganizationsSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.organizations.settings.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSettingsGetCall) Fields

func (c *OrganizationsSettingsGetCall) Fields(s ...googleapi.Field) *OrganizationsSettingsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsSettingsGetCall) Header

func (c *OrganizationsSettingsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsSettingsGetCall) IfNoneMatch

func (c *OrganizationsSettingsGetCall) IfNoneMatch(entityTag string) *OrganizationsSettingsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsSettingsGetCall) View

func (c *OrganizationsSettingsGetCall) View(view string) *OrganizationsSettingsGetCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type OrganizationsSettingsListCall

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

func (*OrganizationsSettingsListCall) Context

func (c *OrganizationsSettingsListCall) Context(ctx context.Context) *OrganizationsSettingsListCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsSettingsListCall) Do

func (c *OrganizationsSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)

Do executes the "resourcesettings.organizations.settings.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1ListSettingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSettingsListCall) Fields

func (c *OrganizationsSettingsListCall) Fields(s ...googleapi.Field) *OrganizationsSettingsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsSettingsListCall) Header

func (c *OrganizationsSettingsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsSettingsListCall) IfNoneMatch

func (c *OrganizationsSettingsListCall) IfNoneMatch(entityTag string) *OrganizationsSettingsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsSettingsListCall) PageSize

func (c *OrganizationsSettingsListCall) PageSize(pageSize int64) *OrganizationsSettingsListCall

PageSize sets the optional parameter "pageSize": Unused. The size of the page to be returned.

func (*OrganizationsSettingsListCall) PageToken

func (c *OrganizationsSettingsListCall) PageToken(pageToken string) *OrganizationsSettingsListCall

PageToken sets the optional parameter "pageToken": Unused. A page token used to retrieve the next page.

func (*OrganizationsSettingsListCall) Pages

func (c *OrganizationsSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*OrganizationsSettingsListCall) View

func (c *OrganizationsSettingsListCall) View(view string) *OrganizationsSettingsListCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type OrganizationsSettingsPatchCall

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

func (*OrganizationsSettingsPatchCall) Context

func (c *OrganizationsSettingsPatchCall) Context(ctx context.Context) *OrganizationsSettingsPatchCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsSettingsPatchCall) Do

func (c *OrganizationsSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.organizations.settings.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsSettingsPatchCall) Fields

func (c *OrganizationsSettingsPatchCall) Fields(s ...googleapi.Field) *OrganizationsSettingsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsSettingsPatchCall) Header

func (c *OrganizationsSettingsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsSettingsService

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

func NewOrganizationsSettingsService

func NewOrganizationsSettingsService(s *Service) *OrganizationsSettingsService

func (*OrganizationsSettingsService) Get

func (r *OrganizationsSettingsService) Get(name string) *OrganizationsSettingsGetCall

Get: Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

- name: The name of the setting to get. See Setting for naming requirements.

func (*OrganizationsSettingsService) List

func (r *OrganizationsSettingsService) List(parent string) *OrganizationsSettingsListCall

List: Lists all the settings that are available on the Cloud resource `parent`.

func (*OrganizationsSettingsService) Patch

func (r *OrganizationsSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *OrganizationsSettingsPatchCall

Patch: Updates a specified 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.

type ProjectsService

type ProjectsService struct {
    Settings *ProjectsSettingsService
    // contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ProjectsSettingsGetCall

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

func (*ProjectsSettingsGetCall) Context

func (c *ProjectsSettingsGetCall) Context(ctx context.Context) *ProjectsSettingsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSettingsGetCall) Do

func (c *ProjectsSettingsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.projects.settings.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSettingsGetCall) Fields

func (c *ProjectsSettingsGetCall) Fields(s ...googleapi.Field) *ProjectsSettingsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSettingsGetCall) Header

func (c *ProjectsSettingsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSettingsGetCall) IfNoneMatch

func (c *ProjectsSettingsGetCall) IfNoneMatch(entityTag string) *ProjectsSettingsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsSettingsGetCall) View

func (c *ProjectsSettingsGetCall) View(view string) *ProjectsSettingsGetCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type ProjectsSettingsListCall

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

func (*ProjectsSettingsListCall) Context

func (c *ProjectsSettingsListCall) Context(ctx context.Context) *ProjectsSettingsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSettingsListCall) Do

func (c *ProjectsSettingsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1ListSettingsResponse, error)

Do executes the "resourcesettings.projects.settings.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1ListSettingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSettingsListCall) Fields

func (c *ProjectsSettingsListCall) Fields(s ...googleapi.Field) *ProjectsSettingsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSettingsListCall) Header

func (c *ProjectsSettingsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSettingsListCall) IfNoneMatch

func (c *ProjectsSettingsListCall) IfNoneMatch(entityTag string) *ProjectsSettingsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsSettingsListCall) PageSize

func (c *ProjectsSettingsListCall) PageSize(pageSize int64) *ProjectsSettingsListCall

PageSize sets the optional parameter "pageSize": Unused. The size of the page to be returned.

func (*ProjectsSettingsListCall) PageToken

func (c *ProjectsSettingsListCall) PageToken(pageToken string) *ProjectsSettingsListCall

PageToken sets the optional parameter "pageToken": Unused. A page token used to retrieve the next page.

func (*ProjectsSettingsListCall) Pages

func (c *ProjectsSettingsListCall) Pages(ctx context.Context, f func(*GoogleCloudResourcesettingsV1ListSettingsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsSettingsListCall) View

func (c *ProjectsSettingsListCall) View(view string) *ProjectsSettingsListCall

View sets the optional parameter "view": The SettingView for this request.

Possible values:

"SETTING_VIEW_UNSPECIFIED" - The default / unset value. The API will

default to the SETTING_VIEW_BASIC view.

"SETTING_VIEW_BASIC" - Include Setting.metadata, but nothing else. This is

the default value (for both ListSettings and GetSetting).

"SETTING_VIEW_EFFECTIVE_VALUE" - Include Setting.effective_value, but

nothing else.

"SETTING_VIEW_LOCAL_VALUE" - Include Setting.local_value, but nothing

else.

type ProjectsSettingsPatchCall

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

func (*ProjectsSettingsPatchCall) Context

func (c *ProjectsSettingsPatchCall) Context(ctx context.Context) *ProjectsSettingsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSettingsPatchCall) Do

func (c *ProjectsSettingsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudResourcesettingsV1Setting, error)

Do executes the "resourcesettings.projects.settings.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudResourcesettingsV1Setting.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSettingsPatchCall) Fields

func (c *ProjectsSettingsPatchCall) Fields(s ...googleapi.Field) *ProjectsSettingsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSettingsPatchCall) Header

func (c *ProjectsSettingsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSettingsService

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

func NewProjectsSettingsService

func NewProjectsSettingsService(s *Service) *ProjectsSettingsService

func (*ProjectsSettingsService) Get

func (r *ProjectsSettingsService) Get(name string) *ProjectsSettingsGetCall

Get: Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.

- name: The name of the setting to get. See Setting for naming requirements.

func (*ProjectsSettingsService) List

func (r *ProjectsSettingsService) List(parent string) *ProjectsSettingsListCall

List: Lists all the settings that are available on the Cloud resource `parent`.

func (*ProjectsSettingsService) Patch

func (r *ProjectsSettingsService) Patch(name string, googlecloudresourcesettingsv1setting *GoogleCloudResourcesettingsV1Setting) *ProjectsSettingsPatchCall

Patch: Updates a specified 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.

type Service

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

    Folders *FoldersService

    Organizations *OrganizationsService

    Projects *ProjectsService
    // contains filtered or unexported fields
}

func New

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

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.