api: google.golang.org/api/servicebroker/v1 Index | Files

package servicebroker

import "google.golang.org/api/servicebroker/v1"

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, 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 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)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

servicebroker-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

type GoogleIamV1__Binding Uses

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`.
    //
    //
    // * `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`.
    Role string `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 Uses

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

type GoogleIamV1__Policy Uses

type GoogleIamV1__Policy struct {
    // Bindings: Associates a list of `members` to a `role`.
    // `bindings` with no members will result in an error.
    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.
    //
    // If no `etag` is provided in the call to `setIamPolicy`, then the
    // existing
    // policy is overwritten.
    Etag string `json:"etag,omitempty"`

    // Version: Specifies the format of the policy.
    //
    // Valid values are 0, 1, and 3. Requests specifying an invalid value
    // will be
    // rejected.
    //
    // Policies with any conditional bindings must specify version 3.
    // Policies
    // without any conditional bindings may specify any valid value or leave
    // the
    // field unset.
    Version int64 `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: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.

**JSON Example**

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",

"serviceAccount:my-other-app@appspot.gserviceaccount.com"

      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

**YAML Example**

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).

func (*GoogleIamV1__Policy) MarshalJSON Uses

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

type GoogleIamV1__SetIamPolicyRequest Uses

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 Uses

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

type GoogleIamV1__TestIamPermissionsRequest Uses

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 Uses

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

type GoogleIamV1__TestIamPermissionsResponse Uses

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 Uses

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

type GoogleType__Expr Uses

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.
    Description string `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.
    Expression string `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.
    Location string `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.
    Title string `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 Uses

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

type Service Uses

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

    V1  *V1Service
    // contains filtered or unexported fields
}

func New Uses

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 Uses

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

NewService creates a new Service.

type V1GetIamPolicyCall Uses

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

func (*V1GetIamPolicyCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1GetIamPolicyCall) Do Uses

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. Any non-2xx status code is an error. Response headers are in either *GoogleIamV1__Policy.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 (*V1GetIamPolicyCall) Fields Uses

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

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

func (*V1GetIamPolicyCall) Header Uses

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

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

func (*V1GetIamPolicyCall) IfNoneMatch Uses

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*V1GetIamPolicyCall) OptionsRequestedPolicyVersion Uses

func (c *V1GetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *V1GetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned.

Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.

Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.

type V1Service Uses

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

func NewV1Service Uses

func NewV1Service(s *Service) *V1Service

func (*V1Service) GetIamPolicy Uses

func (r *V1Service) GetIamPolicy(resource string) *V1GetIamPolicyCall

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*V1Service) SetIamPolicy Uses

func (r *V1Service) SetIamPolicy(resource string, googleiamv1__setiampolicyrequest *GoogleIamV1__SetIamPolicyRequest) *V1SetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy.

func (*V1Service) TestIamPermissions Uses

func (r *V1Service) TestIamPermissions(resource string, googleiamv1__testiampermissionsrequest *GoogleIamV1__TestIamPermissionsRequest) *V1TestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type V1SetIamPolicyCall Uses

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

func (*V1SetIamPolicyCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1SetIamPolicyCall) Do Uses

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. Any non-2xx status code is an error. Response headers are in either *GoogleIamV1__Policy.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 (*V1SetIamPolicyCall) Fields Uses

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

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

func (*V1SetIamPolicyCall) Header Uses

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

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

type V1TestIamPermissionsCall Uses

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

func (*V1TestIamPermissionsCall) Context Uses

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1TestIamPermissionsCall) Do Uses

func (c *V1TestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*GoogleIamV1__TestIamPermissionsResponse, error)

Do executes the "servicebroker.testIamPermissions" call. Exactly one of *GoogleIamV1__TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleIamV1__TestIamPermissionsResponse.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 (*V1TestIamPermissionsCall) Fields Uses

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

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

func (*V1TestIamPermissionsCall) Header Uses

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

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

Package servicebroker imports 14 packages (graph). Updated 2019-09-17. Refresh now. Tools for package owners.