parametermanager

package
v0.244.0 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2025 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package parametermanager provides access to the Parameter Manager API.

For product documentation, see: https://cloud.google.com/secret-manager/parameter-manager/docs/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/parametermanager/v1"
...
ctx := context.Background()
parametermanagerService, err := parametermanager.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:

parametermanagerService, err := parametermanager.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, ...)
parametermanagerService, err := parametermanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListParameterVersionsResponse

type ListParameterVersionsResponse struct {
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ParameterVersions: The list of ParameterVersions
	ParameterVersions []*ParameterVersion `json:"parameterVersions,omitempty"`
	// Unreachable: Unordered list. Locations that could not be reached.
	Unreachable []string `json:"unreachable,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:"-"`
}

ListParameterVersionsResponse: Message for response to listing ParameterVersions

func (ListParameterVersionsResponse) MarshalJSON

func (s ListParameterVersionsResponse) MarshalJSON() ([]byte, error)

type ListParametersResponse

type ListParametersResponse struct {
	// NextPageToken: A token identifying a page of results the server should
	// return.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Parameters: The list of Parameters
	Parameters []*Parameter `json:"parameters,omitempty"`
	// Unreachable: Unordered list. Locations that could not be reached.
	Unreachable []string `json:"unreachable,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:"-"`
}

ListParametersResponse: Message for response to listing Parameters

func (ListParametersResponse) MarshalJSON

func (s ListParametersResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	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. "DisplayName") 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. "DisplayName") 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:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

func (s Location) MarshalJSON() ([]byte, error)

type Parameter

type Parameter struct {
	// CreateTime: Output only. [Output only] Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// Format: Optional. Specifies the format of a Parameter.
	//
	// Possible values:
	//   "PARAMETER_FORMAT_UNSPECIFIED" - The default / unset value. The API will
	// default to the UNFORMATTED format.
	//   "UNFORMATTED" - Unformatted.
	//   "YAML" - YAML format.
	//   "JSON" - JSON format.
	Format string `json:"format,omitempty"`
	// KmsKey: Optional. Customer managed encryption key (CMEK) to use for
	// encrypting the Parameter Versions. If not set, the default Google-managed
	// encryption key will be used. Cloud KMS CryptoKeys must reside in the same
	// location as the Parameter. The expected format is
	// `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
	KmsKey string `json:"kmsKey,omitempty"`
	// Labels: Optional. Labels as key value pairs
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Identifier. [Output only] The resource name of the Parameter in the
	// format `projects/*/locations/*/parameters/*`.
	Name string `json:"name,omitempty"`
	// PolicyMember: Output only. [Output-only] policy member strings of a Google
	// Cloud resource.
	PolicyMember *ResourcePolicyMember `json:"policyMember,omitempty"`
	// UpdateTime: Output only. [Output only] Update time stamp
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

Parameter: Message describing Parameter resource

func (Parameter) MarshalJSON

func (s Parameter) MarshalJSON() ([]byte, error)

type ParameterVersion

type ParameterVersion struct {
	// CreateTime: Output only. [Output only] Create time stamp
	CreateTime string `json:"createTime,omitempty"`
	// Disabled: Optional. Disabled boolean to determine if a ParameterVersion acts
	// as a metadata only resource (payload is never returned if disabled is true).
	// If true any calls will always default to BASIC view even if the user
	// explicitly passes FULL view as part of the request. A render call on a
	// disabled resource fails with an error. Default value is False.
	Disabled bool `json:"disabled,omitempty"`
	// KmsKeyVersion: Optional. Output only. [Output only] The resource name of the
	// KMS key version used to encrypt the ParameterVersion payload. This field is
	// populated only if the Parameter resource has customer managed encryption key
	// (CMEK) configured.
	KmsKeyVersion string `json:"kmsKeyVersion,omitempty"`
	// Name: Identifier. [Output only] The resource name of the ParameterVersion in
	// the format `projects/*/locations/*/parameters/*/versions/*`.
	Name string `json:"name,omitempty"`
	// Payload: Required. Immutable. Payload content of a ParameterVersion
	// resource. This is only returned when the request provides the View value of
	// FULL (default for GET request).
	Payload *ParameterVersionPayload `json:"payload,omitempty"`
	// UpdateTime: Output only. [Output only] Update time stamp
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

ParameterVersion: Message describing ParameterVersion resource

func (ParameterVersion) MarshalJSON

func (s ParameterVersion) MarshalJSON() ([]byte, error)

type ParameterVersionPayload

type ParameterVersionPayload struct {
	// Data: Required. bytes data for storing payload.
	Data string `json:"data,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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:"-"`
}

ParameterVersionPayload: Message for storing a ParameterVersion resource's payload data

func (ParameterVersionPayload) MarshalJSON

func (s ParameterVersionPayload) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall) Context

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

func (*ProjectsLocationsGetCall) Do

Do executes the "parametermanager.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.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 (*ProjectsLocationsGetCall) Fields

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

func (*ProjectsLocationsGetCall) Header

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

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

func (*ProjectsLocationsGetCall) IfNoneMatch

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

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.

type ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Context

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

func (*ProjectsLocationsListCall) Do

Do executes the "parametermanager.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.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 (*ProjectsLocationsListCall) ExtraLocationTypes

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": A list of extra location types that should be used as conditions for controlling the visibility of the locations.

func (*ProjectsLocationsListCall) Fields

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

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

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

func (*ProjectsLocationsListCall) IfNoneMatch

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

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 (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

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.

type ProjectsLocationsParametersCreateCall

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

func (*ProjectsLocationsParametersCreateCall) Context

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

func (*ProjectsLocationsParametersCreateCall) Do

Do executes the "parametermanager.projects.locations.parameters.create" call. Any non-2xx status code is an error. Response headers are in either *Parameter.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 (*ProjectsLocationsParametersCreateCall) Fields

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

func (*ProjectsLocationsParametersCreateCall) Header

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

func (*ProjectsLocationsParametersCreateCall) ParameterId

ParameterId sets the optional parameter "parameterId": Required. Id of the Parameter resource

func (*ProjectsLocationsParametersCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsParametersDeleteCall

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

func (*ProjectsLocationsParametersDeleteCall) Context

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

func (*ProjectsLocationsParametersDeleteCall) Do

Do executes the "parametermanager.projects.locations.parameters.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsParametersDeleteCall) Fields

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

func (*ProjectsLocationsParametersDeleteCall) Header

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

func (*ProjectsLocationsParametersDeleteCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsParametersGetCall

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

func (*ProjectsLocationsParametersGetCall) Context

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

func (*ProjectsLocationsParametersGetCall) Do

Do executes the "parametermanager.projects.locations.parameters.get" call. Any non-2xx status code is an error. Response headers are in either *Parameter.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 (*ProjectsLocationsParametersGetCall) Fields

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

func (*ProjectsLocationsParametersGetCall) Header

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

func (*ProjectsLocationsParametersGetCall) IfNoneMatch

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.

type ProjectsLocationsParametersListCall

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

func (*ProjectsLocationsParametersListCall) Context

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

func (*ProjectsLocationsParametersListCall) Do

Do executes the "parametermanager.projects.locations.parameters.list" call. Any non-2xx status code is an error. Response headers are in either *ListParametersResponse.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 (*ProjectsLocationsParametersListCall) Fields

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

func (*ProjectsLocationsParametersListCall) Filter

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsParametersListCall) Header

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

func (*ProjectsLocationsParametersListCall) IfNoneMatch

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 (*ProjectsLocationsParametersListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Hint for how to order the results

func (*ProjectsLocationsParametersListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsParametersListCall) PageToken

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsParametersListCall) Pages

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.

type ProjectsLocationsParametersPatchCall

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

func (*ProjectsLocationsParametersPatchCall) Context

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

func (*ProjectsLocationsParametersPatchCall) Do

Do executes the "parametermanager.projects.locations.parameters.patch" call. Any non-2xx status code is an error. Response headers are in either *Parameter.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 (*ProjectsLocationsParametersPatchCall) Fields

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

func (*ProjectsLocationsParametersPatchCall) Header

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

func (*ProjectsLocationsParametersPatchCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsParametersPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to specify the fields to be overwritten in the Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.

type ProjectsLocationsParametersService

type ProjectsLocationsParametersService struct {
	Versions *ProjectsLocationsParametersVersionsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsParametersService

func NewProjectsLocationsParametersService(s *Service) *ProjectsLocationsParametersService

func (*ProjectsLocationsParametersService) Create

Create: Creates a new Parameter in a given project and location.

- parent: Value for parent in the format `projects/*/locations/*`.

func (*ProjectsLocationsParametersService) Delete

Delete: Deletes a single Parameter.

  • name: Name of the resource in the format `projects/*/locations/*/parameters/*`.

func (*ProjectsLocationsParametersService) Get

Get: Gets details of a single Parameter.

  • name: Name of the resource in the format `projects/*/locations/*/parameters/*`.

func (*ProjectsLocationsParametersService) List

List: Lists Parameters in a given project and location.

  • parent: Parent value for ListParametersRequest in the format `projects/*/locations/*`.

func (*ProjectsLocationsParametersService) Patch

Patch: Updates a single Parameter.

  • name: Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.

type ProjectsLocationsParametersVersionsCreateCall

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

func (*ProjectsLocationsParametersVersionsCreateCall) Context

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

func (*ProjectsLocationsParametersVersionsCreateCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.create" call. Any non-2xx status code is an error. Response headers are in either *ParameterVersion.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 (*ProjectsLocationsParametersVersionsCreateCall) Fields

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

func (*ProjectsLocationsParametersVersionsCreateCall) Header

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

func (*ProjectsLocationsParametersVersionsCreateCall) ParameterVersionId

ParameterVersionId sets the optional parameter "parameterVersionId": Required. Id of the ParameterVersion resource

func (*ProjectsLocationsParametersVersionsCreateCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsParametersVersionsDeleteCall

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

func (*ProjectsLocationsParametersVersionsDeleteCall) Context

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

func (*ProjectsLocationsParametersVersionsDeleteCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.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 (*ProjectsLocationsParametersVersionsDeleteCall) Fields

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

func (*ProjectsLocationsParametersVersionsDeleteCall) Header

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

func (*ProjectsLocationsParametersVersionsDeleteCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsParametersVersionsGetCall

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

func (*ProjectsLocationsParametersVersionsGetCall) Context

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

func (*ProjectsLocationsParametersVersionsGetCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.get" call. Any non-2xx status code is an error. Response headers are in either *ParameterVersion.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 (*ProjectsLocationsParametersVersionsGetCall) Fields

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

func (*ProjectsLocationsParametersVersionsGetCall) Header

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

func (*ProjectsLocationsParametersVersionsGetCall) IfNoneMatch

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 (*ProjectsLocationsParametersVersionsGetCall) View

View sets the optional parameter "view": View of the ParameterVersion. In the default FULL view, all metadata & payload associated with the ParameterVersion will be returned.

Possible values:

"VIEW_UNSPECIFIED" - The default / unset value. The API will default to

the FULL view..

"BASIC" - Include only the metadata for the resource.
"FULL" - Include metadata & other relevant payload data as well. This is

the default view.

type ProjectsLocationsParametersVersionsListCall

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

func (*ProjectsLocationsParametersVersionsListCall) Context

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

func (*ProjectsLocationsParametersVersionsListCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListParameterVersionsResponse.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 (*ProjectsLocationsParametersVersionsListCall) Fields

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

func (*ProjectsLocationsParametersVersionsListCall) Filter

Filter sets the optional parameter "filter": Filtering results

func (*ProjectsLocationsParametersVersionsListCall) Header

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

func (*ProjectsLocationsParametersVersionsListCall) IfNoneMatch

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 (*ProjectsLocationsParametersVersionsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Hint for how to order the results

func (*ProjectsLocationsParametersVersionsListCall) PageSize

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

func (*ProjectsLocationsParametersVersionsListCall) PageToken

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return.

func (*ProjectsLocationsParametersVersionsListCall) Pages

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.

type ProjectsLocationsParametersVersionsPatchCall

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

func (*ProjectsLocationsParametersVersionsPatchCall) Context

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

func (*ProjectsLocationsParametersVersionsPatchCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.patch" call. Any non-2xx status code is an error. Response headers are in either *ParameterVersion.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 (*ProjectsLocationsParametersVersionsPatchCall) Fields

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

func (*ProjectsLocationsParametersVersionsPatchCall) Header

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

func (*ProjectsLocationsParametersVersionsPatchCall) RequestId

RequestId sets the optional parameter "requestId": An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsParametersVersionsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Field mask is used to specify the fields to be overwritten in the ParameterVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.

type ProjectsLocationsParametersVersionsRenderCall

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

func (*ProjectsLocationsParametersVersionsRenderCall) Context

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

func (*ProjectsLocationsParametersVersionsRenderCall) Do

Do executes the "parametermanager.projects.locations.parameters.versions.render" call. Any non-2xx status code is an error. Response headers are in either *RenderParameterVersionResponse.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 (*ProjectsLocationsParametersVersionsRenderCall) Fields

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

func (*ProjectsLocationsParametersVersionsRenderCall) Header

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

func (*ProjectsLocationsParametersVersionsRenderCall) IfNoneMatch

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.

type ProjectsLocationsParametersVersionsService

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

func NewProjectsLocationsParametersVersionsService

func NewProjectsLocationsParametersVersionsService(s *Service) *ProjectsLocationsParametersVersionsService

func (*ProjectsLocationsParametersVersionsService) Create

Create: Creates a new ParameterVersion in a given project, location, and parameter.

  • parent: Value for parent in the format `projects/*/locations/*/parameters/*`.

func (*ProjectsLocationsParametersVersionsService) Delete

Delete: Deletes a single ParameterVersion.

  • name: Name of the resource in the format `projects/*/locations/*/parameters/*/versions/*`.

func (*ProjectsLocationsParametersVersionsService) Get

Get: Gets details of a single ParameterVersion.

  • name: Name of the resource in the format `projects/*/locations/*/parameters/*/versions/*`.

func (*ProjectsLocationsParametersVersionsService) List

List: Lists ParameterVersions in a given project, location, and parameter.

  • parent: Parent value for ListParameterVersionsRequest in the format `projects/*/locations/*/parameters/*`.

func (*ProjectsLocationsParametersVersionsService) Patch

Patch: Updates a single ParameterVersion.

  • name: Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.

func (*ProjectsLocationsParametersVersionsService) Render

Render: Gets rendered version of a ParameterVersion.

- name: Name of the resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Parameters *ProjectsLocationsParametersService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type RenderParameterVersionResponse

type RenderParameterVersionResponse struct {
	// ParameterVersion: Output only. Resource identifier of a ParameterVersion in
	// the format `projects/*/locations/*/parameters/*/versions/*`.
	ParameterVersion string `json:"parameterVersion,omitempty"`
	// Payload: Payload content of a ParameterVersion resource.
	Payload *ParameterVersionPayload `json:"payload,omitempty"`
	// RenderedPayload: Output only. Server generated rendered version of the user
	// provided payload data (ParameterVersionPayload) which has substitutions of
	// all (if any) references to a SecretManager SecretVersion resources. This
	// substitution only works for a Parameter which is in JSON or YAML format.
	RenderedPayload string `json:"renderedPayload,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ParameterVersion") 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. "ParameterVersion") 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:"-"`
}

RenderParameterVersionResponse: Message describing RenderParameterVersionResponse resource

func (RenderParameterVersionResponse) MarshalJSON

func (s RenderParameterVersionResponse) MarshalJSON() ([]byte, error)

type ResourcePolicyMember

type ResourcePolicyMember struct {
	// IamPolicyNamePrincipal: Output only. IAM policy binding member referring to
	// a Google Cloud resource by user-assigned name (https://google.aip.dev/122).
	// If a resource is deleted and recreated with the same name, the binding will
	// be applicable to the new resource. Example:
	// `principal://parametermanager.googleapis.com/projects/12345/name/locations/us
	// -central1-a/parameters/my-parameter`
	IamPolicyNamePrincipal string `json:"iamPolicyNamePrincipal,omitempty"`
	// IamPolicyUidPrincipal: Output only. IAM policy binding member referring to a
	// Google Cloud resource by system-assigned unique identifier
	// (https://google.aip.dev/148#uid). If a resource is deleted and recreated
	// with the same name, the binding will not be applicable to the new resource
	// Example:
	// `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-
	// central1-a/parameters/a918fed5`
	IamPolicyUidPrincipal string `json:"iamPolicyUidPrincipal,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IamPolicyNamePrincipal") 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. "IamPolicyNamePrincipal") 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:"-"`
}

ResourcePolicyMember: Output-only policy member strings of a Google Cloud resource's built-in identity.

func (ResourcePolicyMember) MarshalJSON

func (s ResourcePolicyMember) MarshalJSON() ([]byte, error)

type Service

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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.