servicebroker
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package servicebroker provides access to the Service Broker API.
For product documentation, see:https://cloud.google.com/kubernetes-engine/docs/concepts/add-on/service-broker
Creating a client¶
Usage example:
import "google.golang.org/api/servicebroker/v1"...ctx := context.Background()servicebrokerService, err := servicebroker.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, seehttps://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 option.WithAPIKey:
servicebrokerService, err := servicebroker.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)servicebrokerService, err := servicebroker.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seehttps://godoc.org/google.golang.org/api/option/ for details on options.
Index¶
- Constants
- type GoogleIamV1__Binding
- type GoogleIamV1__Policy
- type GoogleIamV1__SetIamPolicyRequest
- type GoogleIamV1__TestIamPermissionsRequest
- type GoogleIamV1__TestIamPermissionsResponse
- type GoogleType__Expr
- type Service
- type V1GetIamPolicyCall
- func (c *V1GetIamPolicyCall) Context(ctx context.Context) *V1GetIamPolicyCall
- func (c *V1GetIamPolicyCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__Policy, error)
- func (c *V1GetIamPolicyCall) Fields(s ...googleapi.Field) *V1GetIamPolicyCall
- func (c *V1GetIamPolicyCall) Header() http.Header
- func (c *V1GetIamPolicyCall) IfNoneMatch(entityTag string) *V1GetIamPolicyCall
- func (c *V1GetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *V1GetIamPolicyCall
- type V1Service
- type V1SetIamPolicyCall
- type V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Context(ctx context.Context) *V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__TestIamPermissionsResponse, error)
- func (c *V1TestIamPermissionsCall) Fields(s ...googleapi.Field) *V1TestIamPermissionsCall
- func (c *V1TestIamPermissionsCall) Header() http.Header
Constants¶
const (// View and manage your data across Google Cloud Platform servicesCloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeGoogleIamV1__Binding¶
type GoogleIamV1__Binding struct {// Condition: The condition that is associated with this binding.// NOTE: An unsatisfied condition will not allow user access via// current// binding. Different bindings, including their conditions, are// examined// independently.Condition *GoogleType__Expr `json:"condition,omitempty"`// Members: Specifies the identities requesting access for a Cloud// Platform resource.// `members` can have the following values://// * `allUsers`: A special identifier that represents anyone who is// on the internet; with or without a Google account.//// * `allAuthenticatedUsers`: A special identifier that represents// anyone// who is authenticated with a Google account or a service// account.//// * `user:{emailid}`: An email address that represents a specific// Google// account. For example, `alice@example.com` .////// * `serviceAccount:{emailid}`: An email address that represents a// service// account. For example,// `my-other-app@appspot.gserviceaccount.com`.//// * `group:{emailid}`: An email address that represents a Google// group.// For example, `admins@example.com`.//// * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique// identifier) representing a user that has been recently deleted.// For// example, `alice@example.com?uid=123456789012345678901`. If the// user is// recovered, this value reverts to `user:{emailid}` and the// recovered user// retains the role in the binding.//// * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address// (plus// unique identifier) representing a service account that has been// recently// deleted. For example,//// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.//// If the service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account// retains the// role in the binding.//// * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus// unique// identifier) representing a Google group that has been recently// deleted. For example,// `admins@example.com?uid=123456789012345678901`. If// the group is recovered, this value reverts to `group:{emailid}`// and the// recovered group retains the role in the binding.////// * `domain:{domain}`: The G Suite domain (primary) that represents all// the// users of that domain. For example, `google.com` or// `example.com`.////Members []string `json:"members,omitempty"`// Role: Role that is assigned to `members`.// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleIamV1__Binding: Associates `members` with a `role`.
func (*GoogleIamV1__Binding)MarshalJSON¶
func (s *GoogleIamV1__Binding) MarshalJSON() ([]byte,error)
typeGoogleIamV1__Policy¶
type GoogleIamV1__Policy struct {// Bindings: Associates a list of `members` to a `role`. Optionally, may// specify a// `condition` that determines how and when the `bindings` are applied.// Each// of the `bindings` must contain at least one member.Bindings []*GoogleIamV1__Binding `json:"bindings,omitempty"`// Etag: `etag` is used for optimistic concurrency control as a way to// help// prevent simultaneous updates of a policy from overwriting each// other.// It is strongly suggested that systems make use of the `etag` in// the// read-modify-write cycle to perform policy updates in order to avoid// race// conditions: An `etag` is returned in the response to `getIamPolicy`,// and// systems are expected to put that etag in the request to// `setIamPolicy` to// ensure that their change will be applied to the same version of the// policy.//// **Important:** If you use IAM Conditions, you must include the `etag`// field// whenever you call `setIamPolicy`. If you omit this field, then IAM// allows// you to overwrite a version `3` policy with a version `1` policy, and// all of// the conditions in the version `3` policy are lost.Etagstring `json:"etag,omitempty"`// Version: Specifies the format of the policy.//// Valid values are `0`, `1`, and `3`. Requests that specify an invalid// value// are rejected.//// Any operation that affects conditional role bindings must specify// version// `3`. This requirement applies to the following operations://// * Getting a policy that includes a conditional role binding// * Adding a conditional role binding to a policy// * Changing a conditional role binding in a policy// * Removing any role binding, with or without a condition, from a// policy// that includes conditions//// **Important:** If you use IAM Conditions, you must include the `etag`// field// whenever you call `setIamPolicy`. If you omit this field, then IAM// allows// you to overwrite a version `3` policy with a version `1` policy, and// all of// the conditions in the version `3` policy are lost.//// If a policy does not include any conditions, operations on that// policy may// specify any valid version or leave the field unset.Versionint64 `json:"version,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Bindings") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Bindings") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleIamV1__Policy: An Identity and Access Management (IAM) policy,which specifies accesscontrols for Google Cloud resources.
A `Policy` is a collection of `bindings`. A `binding` binds one ormore`members` to a single `role`. Members can be user accounts, serviceaccounts,Google groups, and domains (such as G Suite). A `role` is a namedlist ofpermissions; each `role` can be an IAM predefined role or auser-createdcustom role.
Optionally, a `binding` can specify a `condition`, which is alogicalexpression that allows access to a resource only if the expressionevaluatesto `true`. A condition can add constraints based on attributes oftherequest, the resource, or both.
**JSON example:**
{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com","serviceAccount:my-project-id@appspot.gserviceaccount.com"
]},{ "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time <timestamp('2020-10-01T00:00:00.000Z')",
} } ], "etag": "BwWWja0YfJA=", "version": 3}
**YAML example:**
bindings:- members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin- members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z')
- etag: BwWWja0YfJA=
- version: 3
For a description of IAM and its features, see the[IAM documentation](https://cloud.google.com/iam/docs/).
func (*GoogleIamV1__Policy)MarshalJSON¶
func (s *GoogleIamV1__Policy) MarshalJSON() ([]byte,error)
typeGoogleIamV1__SetIamPolicyRequest¶
type GoogleIamV1__SetIamPolicyRequest struct {// Policy: REQUIRED: The complete policy to be applied to the// `resource`. The size of// the policy is limited to a few 10s of KB. An empty policy is a// valid policy but certain Cloud Platform services (such as// Projects)// might reject them.Policy *GoogleIamV1__Policy `json:"policy,omitempty"`// ForceSendFields is a list of field names (e.g. "Policy") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Policy") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleIamV1__SetIamPolicyRequest: Request message for `SetIamPolicy`method.
func (*GoogleIamV1__SetIamPolicyRequest)MarshalJSON¶
func (s *GoogleIamV1__SetIamPolicyRequest) MarshalJSON() ([]byte,error)
typeGoogleIamV1__TestIamPermissionsRequest¶
type GoogleIamV1__TestIamPermissionsRequest struct {// Permissions: The set of permissions to check for the `resource`.// Permissions with// wildcards (such as '*' or 'storage.*') are not allowed. For// more// information see// [IAM// Overview](https://cloud.google.com/iam/docs/overview#permissions).Permissions []string `json:"permissions,omitempty"`// ForceSendFields is a list of field names (e.g. "Permissions") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleIamV1__TestIamPermissionsRequest: Request message for`TestIamPermissions` method.
func (*GoogleIamV1__TestIamPermissionsRequest)MarshalJSON¶
func (s *GoogleIamV1__TestIamPermissionsRequest) MarshalJSON() ([]byte,error)
typeGoogleIamV1__TestIamPermissionsResponse¶
type GoogleIamV1__TestIamPermissionsResponse struct {// Permissions: A subset of `TestPermissionsRequest.permissions` that// the caller is// allowed.Permissions []string `json:"permissions,omitempty"`// ServerResponse contains the HTTP response code and headers from the// server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Permissions") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Permissions") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleIamV1__TestIamPermissionsResponse: Response message for`TestIamPermissions` method.
func (*GoogleIamV1__TestIamPermissionsResponse)MarshalJSON¶
func (s *GoogleIamV1__TestIamPermissionsResponse) MarshalJSON() ([]byte,error)
typeGoogleType__Expr¶
type GoogleType__Expr struct {// Description: An optional description of the expression. This is a// longer text which// describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in// Common Expression Language syntax.//// The application context of the containing message determines// which// well-known feature set of CEL is supported.Expressionstring `json:"expression,omitempty"`// Location: An optional string indicating the location of the// expression for error// reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: An optional title for the expression, i.e. a short string// describing// its purpose. This can be used e.g. in UIs which allow to enter// the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}GoogleType__Expr: Represents an expression text. Example:
title: "User account presence"description: "Determines whether the request has a user account"expression: "size(request.user) > 0"
func (*GoogleType__Expr)MarshalJSON¶
func (s *GoogleType__Expr) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentV1 *V1Service// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeV1GetIamPolicyCall¶
type V1GetIamPolicyCall struct {// contains filtered or unexported fields}func (*V1GetIamPolicyCall)Context¶
func (c *V1GetIamPolicyCall) Context(ctxcontext.Context) *V1GetIamPolicyCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*V1GetIamPolicyCall)Do¶
func (c *V1GetIamPolicyCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__Policy,error)
Do executes the "servicebroker.getIamPolicy" call.Exactly one of *GoogleIamV1__Policy or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*GoogleIamV1__Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*V1GetIamPolicyCall)Fields¶
func (c *V1GetIamPolicyCall) Fields(s ...googleapi.Field) *V1GetIamPolicyCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*V1GetIamPolicyCall)Header¶
func (c *V1GetIamPolicyCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
func (*V1GetIamPolicyCall)IfNoneMatch¶
func (c *V1GetIamPolicyCall) IfNoneMatch(entityTagstring) *V1GetIamPolicyCall
IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.
func (*V1GetIamPolicyCall)OptionsRequestedPolicyVersion¶added inv0.8.0
func (c *V1GetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *V1GetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The policy format version to bereturned.
Valid values are 0, 1, and 3. Requests specifying an invalid valuewill berejected.
Requests for policies with any conditional bindings must specifyversion 3.Policies without any conditional bindings may specify any valid valueorleave the field unset.
typeV1Service¶
type V1Service struct {// contains filtered or unexported fields}funcNewV1Service¶
func (*V1Service)GetIamPolicy¶
func (r *V1Service) GetIamPolicy(resourcestring) *V1GetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource.Returns an empty policy if the resource exists and does not have apolicyset.
func (*V1Service)SetIamPolicy¶
func (r *V1Service) SetIamPolicy(resourcestring, googleiamv1__setiampolicyrequest *GoogleIamV1__SetIamPolicyRequest) *V1SetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specifiedresource. Replaces anyexisting policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT andPERMISSION_DENIED
func (*V1Service)TestIamPermissions¶
func (r *V1Service) TestIamPermissions(resourcestring, googleiamv1__testiampermissionsrequest *GoogleIamV1__TestIamPermissionsRequest) *V1TestIamPermissionsCall
TestIamPermissions: Returns permissions that a caller has on thespecified resource.If the resource does not exist, this will return an empty setofpermissions, not a NOT_FOUND error.
Note: This operation is designed to be used for buildingpermission-awareUIs and command-line tools, not for authorization checking. Thisoperationmay "fail open" without warning.
typeV1SetIamPolicyCall¶
type V1SetIamPolicyCall struct {// contains filtered or unexported fields}func (*V1SetIamPolicyCall)Context¶
func (c *V1SetIamPolicyCall) Context(ctxcontext.Context) *V1SetIamPolicyCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*V1SetIamPolicyCall)Do¶
func (c *V1SetIamPolicyCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__Policy,error)
Do executes the "servicebroker.setIamPolicy" call.Exactly one of *GoogleIamV1__Policy or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*GoogleIamV1__Policy.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*V1SetIamPolicyCall)Fields¶
func (c *V1SetIamPolicyCall) Fields(s ...googleapi.Field) *V1SetIamPolicyCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*V1SetIamPolicyCall)Header¶
func (c *V1SetIamPolicyCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
typeV1TestIamPermissionsCall¶
type V1TestIamPermissionsCall struct {// contains filtered or unexported fields}func (*V1TestIamPermissionsCall)Context¶
func (c *V1TestIamPermissionsCall) Context(ctxcontext.Context) *V1TestIamPermissionsCall
Context sets the context to be used in this call's Do method. Anypending HTTP request will be aborted if the provided context iscanceled.
func (*V1TestIamPermissionsCall)Do¶
func (c *V1TestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__TestIamPermissionsResponse,error)
Do executes the "servicebroker.testIamPermissions" call.Exactly one of *GoogleIamV1__TestIamPermissionsResponse or error willbe non-nil. Any non-2xx status code is an error. Response headers arein either*GoogleIamV1__TestIamPermissionsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.
func (*V1TestIamPermissionsCall)Fields¶
func (c *V1TestIamPermissionsCall) Fields(s ...googleapi.Field) *V1TestIamPermissionsCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.
func (*V1TestIamPermissionsCall)Header¶
func (c *V1TestIamPermissionsCall) Header()http.Header
Header returns an http.Header that can be modified by the caller toadd HTTP headers to the request.
Source Files