Documentation ¶
Overview ¶
Package memcache provides access to the Cloud Memorystore for Memcached API.
For product documentation, see: https://cloud.google.com/memorystore/
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/memcache/v1" ... ctx := context.Background() memcacheService, err := memcache.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:
memcacheService, err := memcache.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, ...) memcacheService, err := memcache.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See google.golang.org/api/option.ClientOption for details on options.
Index ¶
- Constants
- type ApplyParametersRequest
- type CancelOperationRequest
- type DailyCycle
- type Date
- type DenyMaintenancePeriod
- type Empty
- type GoogleCloudMemcacheV1LocationMetadata
- type GoogleCloudMemcacheV1MaintenancePolicy
- type GoogleCloudMemcacheV1OperationMetadata
- type GoogleCloudMemcacheV1UpgradeInstanceRequest
- type GoogleCloudMemcacheV1ZoneMetadata
- type GoogleCloudSaasacceleratorManagementProvidersV1Instance
- type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule
- type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings
- type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata
- type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter
- type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility
- type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource
- type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility
- type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata
- type Instance
- type InstanceMessage
- type ListInstancesResponse
- type ListLocationsResponse
- type ListOperationsResponse
- type Location
- type LocationMetadata
- type MaintenancePolicy
- type MaintenanceSchedule
- type MaintenanceWindow
- type MemcacheParameters
- type Node
- type NodeConfig
- type Operation
- type OperationMetadata
- type ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Header() http.Header
- func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
- type ProjectsLocationsInstancesApplyParametersCall
- func (c *ProjectsLocationsInstancesApplyParametersCall) Context(ctx context.Context) *ProjectsLocationsInstancesApplyParametersCall
- func (c *ProjectsLocationsInstancesApplyParametersCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesApplyParametersCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesApplyParametersCall
- func (c *ProjectsLocationsInstancesApplyParametersCall) Header() http.Header
- type ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall
- func (c *ProjectsLocationsInstancesCreateCall) Header() http.Header
- func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceId string) *ProjectsLocationsInstancesCreateCall
- type ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall
- func (c *ProjectsLocationsInstancesDeleteCall) Header() http.Header
- type ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance, error)
- func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall
- func (c *ProjectsLocationsInstancesGetCall) Header() http.Header
- func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesGetCall
- type ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)
- func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Filter(filter string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Header() http.Header
- func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall
- func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error
- type ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPatchCall
- func (c *ProjectsLocationsInstancesPatchCall) Header() http.Header
- func (c *ProjectsLocationsInstancesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesPatchCall
- type ProjectsLocationsInstancesRescheduleMaintenanceCall
- func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Context(ctx context.Context) *ProjectsLocationsInstancesRescheduleMaintenanceCall
- func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRescheduleMaintenanceCall
- func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Header() http.Header
- type ProjectsLocationsInstancesService
- func (r *ProjectsLocationsInstancesService) ApplyParameters(name string, applyparametersrequest *ApplyParametersRequest) *ProjectsLocationsInstancesApplyParametersCall
- func (r *ProjectsLocationsInstancesService) Create(parent string, instance *Instance) *ProjectsLocationsInstancesCreateCall
- func (r *ProjectsLocationsInstancesService) Delete(name string) *ProjectsLocationsInstancesDeleteCall
- func (r *ProjectsLocationsInstancesService) Get(name string) *ProjectsLocationsInstancesGetCall
- func (r *ProjectsLocationsInstancesService) List(parent string) *ProjectsLocationsInstancesListCall
- func (r *ProjectsLocationsInstancesService) Patch(name string, instance *Instance) *ProjectsLocationsInstancesPatchCall
- func (r *ProjectsLocationsInstancesService) RescheduleMaintenance(instance string, reschedulemaintenancerequest *RescheduleMaintenanceRequest) *ProjectsLocationsInstancesRescheduleMaintenanceCall
- func (r *ProjectsLocationsInstancesService) UpdateParameters(name string, updateparametersrequest *UpdateParametersRequest) *ProjectsLocationsInstancesUpdateParametersCall
- func (r *ProjectsLocationsInstancesService) Upgrade(name string, ...) *ProjectsLocationsInstancesUpgradeCall
- type ProjectsLocationsInstancesUpdateParametersCall
- func (c *ProjectsLocationsInstancesUpdateParametersCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpdateParametersCall
- func (c *ProjectsLocationsInstancesUpdateParametersCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesUpdateParametersCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpdateParametersCall
- func (c *ProjectsLocationsInstancesUpdateParametersCall) Header() http.Header
- type ProjectsLocationsInstancesUpgradeCall
- func (c *ProjectsLocationsInstancesUpgradeCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpgradeCall
- func (c *ProjectsLocationsInstancesUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsInstancesUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpgradeCall
- func (c *ProjectsLocationsInstancesUpgradeCall) Header() http.Header
- type ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
- func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Header() http.Header
- func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
- type ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
- func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
- type ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
- func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
- type ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
- func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
- func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
- type ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Header() http.Header
- func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
- func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type ProjectsLocationsOperationsService
- func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
- func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
- func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
- func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
- type ProjectsLocationsService
- type ProjectsService
- type RescheduleMaintenanceRequest
- type Schedule
- type Service
- type Status
- type TimeOfDay
- type UpdateParametersRequest
- type UpdatePolicy
- type WeeklyCycle
- type WeeklyMaintenanceWindow
- type ZoneMetadata
Constants ¶
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 ApplyParametersRequest ¶
type ApplyParametersRequest struct { // ApplyAll: Whether to apply instance-level parameter group to all nodes. If // set to true, users are restricted from specifying individual nodes, and // `ApplyParameters` updates all nodes within the instance. ApplyAll bool `json:"applyAll,omitempty"` // NodeIds: Nodes to which the instance-level parameter group is applied. NodeIds []string `json:"nodeIds,omitempty"` // ForceSendFields is a list of field names (e.g. "ApplyAll") 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. "ApplyAll") 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:"-"` }
ApplyParametersRequest: Request for ApplyParameters.
func (ApplyParametersRequest) MarshalJSON ¶
func (s ApplyParametersRequest) MarshalJSON() ([]byte, error)
type CancelOperationRequest ¶
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type DailyCycle ¶ added in v0.37.0
type DailyCycle struct { // Duration: Output only. Duration of the time window, set by service producer. Duration string `json:"duration,omitempty"` // StartTime: Time within the day to start the operations. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Duration") 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. "Duration") 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:"-"` }
DailyCycle: Time window specified for daily operations.
func (DailyCycle) MarshalJSON ¶ added in v0.37.0
func (s DailyCycle) MarshalJSON() ([]byte, error)
type Date ¶ added in v0.37.0
type Date struct { // Day: Day of a month. Must be from 1 to 31 and valid for the year and month, // or 0 to specify a year by itself or a year and month where the day isn't // significant. Day int64 `json:"day,omitempty"` // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without // a month and day. Month int64 `json:"month,omitempty"` // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date // without a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"` }
Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
func (Date) MarshalJSON ¶ added in v0.37.0
type DenyMaintenancePeriod ¶ added in v0.37.0
type DenyMaintenancePeriod struct { // EndDate: Deny period end date. This can be: * A full date, with non-zero // year, month and day values. * A month and day value, with a zero year. // Allows recurring deny periods each year. Date matching this period will have // to be before the end. EndDate *Date `json:"endDate,omitempty"` // StartDate: Deny period start date. This can be: * A full date, with non-zero // year, month and day values. * A month and day value, with a zero year. // Allows recurring deny periods each year. Date matching this period will have // to be the same or after the start. StartDate *Date `json:"startDate,omitempty"` // Time: Time in UTC when the Blackout period starts on start_date and ends on // end_date. This can be: * Full time. * All zeros for 00:00:00 UTC Time *TimeOfDay `json:"time,omitempty"` // ForceSendFields is a list of field names (e.g. "EndDate") 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. "EndDate") 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:"-"` }
DenyMaintenancePeriod: DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.
func (DenyMaintenancePeriod) MarshalJSON ¶ added in v0.37.0
func (s DenyMaintenancePeriod) MarshalJSON() ([]byte, error)
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 GoogleCloudMemcacheV1LocationMetadata ¶ added in v0.44.0
type GoogleCloudMemcacheV1LocationMetadata struct { // AvailableZones: Output only. The set of available zones in the location. The // map is keyed by the lowercase ID of each zone, as defined by GCE. These keys // can be specified in the `zones` field when creating a Memcached instance. AvailableZones map[string]GoogleCloudMemcacheV1ZoneMetadata `json:"availableZones,omitempty"` // ForceSendFields is a list of field names (e.g. "AvailableZones") 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. "AvailableZones") 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:"-"` }
GoogleCloudMemcacheV1LocationMetadata: Metadata for the given google.cloud.location.Location.
func (GoogleCloudMemcacheV1LocationMetadata) MarshalJSON ¶ added in v0.44.0
func (s GoogleCloudMemcacheV1LocationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudMemcacheV1MaintenancePolicy ¶ added in v0.74.0
type GoogleCloudMemcacheV1MaintenancePolicy struct { // CreateTime: Output only. The time when the policy was created. CreateTime string `json:"createTime,omitempty"` // Description: Description of what this policy is for. Create/Update methods // return INVALID_ARGUMENT if the length is greater than 512. Description string `json:"description,omitempty"` // UpdateTime: Output only. The time when the policy was updated. UpdateTime string `json:"updateTime,omitempty"` // WeeklyMaintenanceWindow: Required. Maintenance window that is applied to // resources covered by this policy. Minimum 1. For the current version, the // maximum number of weekly_maintenance_windows is expected to be one. WeeklyMaintenanceWindow []*WeeklyMaintenanceWindow `json:"weeklyMaintenanceWindow,omitempty"` // 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:"-"` }
GoogleCloudMemcacheV1MaintenancePolicy: Maintenance policy per instance.
func (GoogleCloudMemcacheV1MaintenancePolicy) MarshalJSON ¶ added in v0.74.0
func (s GoogleCloudMemcacheV1MaintenancePolicy) MarshalJSON() ([]byte, error)
type GoogleCloudMemcacheV1OperationMetadata ¶
type GoogleCloudMemcacheV1OperationMetadata struct { // ApiVersion: Output only. API version used to start the operation. ApiVersion string `json:"apiVersion,omitempty"` // CancelRequested: Output only. Identifies whether the user has requested // cancellation of the operation. Operations that have successfully been // cancelled have Operation.error value with a google.rpc.Status.code of 1, // corresponding to `Code.CANCELLED`. CancelRequested bool `json:"cancelRequested,omitempty"` // CreateTime: Output only. Time when the operation was created. CreateTime string `json:"createTime,omitempty"` // EndTime: Output only. Time when the operation finished running. EndTime string `json:"endTime,omitempty"` // StatusDetail: Output only. Human-readable status of the operation, if any. StatusDetail string `json:"statusDetail,omitempty"` // Target: Output only. Server-defined resource path for the target of the // operation. Target string `json:"target,omitempty"` // Verb: Output only. Name of the verb executed by the operation. Verb string `json:"verb,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"` }
GoogleCloudMemcacheV1OperationMetadata: Represents the metadata of a long-running operation.
func (GoogleCloudMemcacheV1OperationMetadata) MarshalJSON ¶
func (s GoogleCloudMemcacheV1OperationMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudMemcacheV1UpgradeInstanceRequest ¶ added in v0.141.0
type GoogleCloudMemcacheV1UpgradeInstanceRequest struct { // MemcacheVersion: Required. Specifies the target version of memcached engine // to upgrade to. // // Possible values: // "MEMCACHE_VERSION_UNSPECIFIED" - Memcache version is not specified by // customer // "MEMCACHE_1_5" - Memcached 1.5 version. // "MEMCACHE_1_6_15" - Memcached 1.6.15 version. MemcacheVersion string `json:"memcacheVersion,omitempty"` // ForceSendFields is a list of field names (e.g. "MemcacheVersion") 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. "MemcacheVersion") 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:"-"` }
GoogleCloudMemcacheV1UpgradeInstanceRequest: Request for UpgradeInstance.
func (GoogleCloudMemcacheV1UpgradeInstanceRequest) MarshalJSON ¶ added in v0.141.0
func (s GoogleCloudMemcacheV1UpgradeInstanceRequest) MarshalJSON() ([]byte, error)
type GoogleCloudMemcacheV1ZoneMetadata ¶ added in v0.44.0
type GoogleCloudMemcacheV1ZoneMetadata struct { }
type GoogleCloudSaasacceleratorManagementProvidersV1Instance ¶
type GoogleCloudSaasacceleratorManagementProvidersV1Instance struct { // ConsumerDefinedName: consumer_defined_name is the name of the instance set // by the service consumers. Generally this is different from the `name` field // which reperesents the system-assigned id of the instance which the service // consumers do not recognize. This is a required field for tenants onboarding // to Maintenance Window notifications // (go/slm-rollout-maintenance-policies#prerequisites). ConsumerDefinedName string `json:"consumerDefinedName,omitempty"` // CreateTime: Output only. Timestamp when the resource was created. CreateTime string `json:"createTime,omitempty"` // InstanceType: Optional. The instance_type of this instance of format: // projects/{project_number}/locations/{location_id}/instanceTypes/{instance_typ // e_id}. Instance Type represents a high-level tier or SKU of the service that // this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses // 'instance_type' along with 'software_versions' to determine whether instance // needs an update or not. InstanceType string `json:"instanceType,omitempty"` // Labels: Optional. Resource labels to represent user provided metadata. Each // label is a key-value pair, where both the key and the value are arbitrary // strings provided by the user. Labels map[string]string `json:"labels,omitempty"` // MaintenancePolicyNames: Optional. The MaintenancePolicies that have been // attached to the instance. The key must be of the type name of the oneof // policy name defined in MaintenancePolicy, and the referenced policy must // define the same policy type. For details, please refer to go/mr-user-guide. // Should not be set if maintenance_settings.maintenance_policies is set. MaintenancePolicyNames map[string]string `json:"maintenancePolicyNames,omitempty"` // MaintenanceSchedules: The MaintenanceSchedule contains the scheduling // information of published maintenance schedule with same key as // software_versions. MaintenanceSchedules map[string]GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule `json:"maintenanceSchedules,omitempty"` // MaintenanceSettings: Optional. The MaintenanceSettings associated with // instance. MaintenanceSettings *GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings `json:"maintenanceSettings,omitempty"` // Name: Unique name of the resource. It uses the form: // `projects/{project_number}/locations/{location_id}/instances/{instance_id}` // Note: This name is passed, stored and logged across the rollout system. So // use of consumer project_id or any other consumer PII in the name is strongly // discouraged for wipeout (go/wipeout) compliance. See // go/elysium/project_ids#storage-guidance for more details. Name string `json:"name,omitempty"` // NotificationParameters: Optional. notification_parameter are information // that service producers may like to include that is not relevant to Rollout. // This parameter will only be passed to Gamma and Cloud Logging for // notification/logging purpose. NotificationParameters map[string]GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter `json:"notificationParameters,omitempty"` // ProducerMetadata: Output only. Custom string attributes used primarily to // expose producer-specific information in monitoring dashboards. See // go/get-instance-metadata. ProducerMetadata map[string]string `json:"producerMetadata,omitempty"` // ProvisionedResources: Output only. The list of data plane resources // provisioned for this instance, e.g. compute VMs. See // go/get-instance-metadata. ProvisionedResources []*GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource `json:"provisionedResources,omitempty"` // SlmInstanceTemplate: Link to the SLM instance template. Only populated when // updating SLM instances via SSA's Actuation service adaptor. Service // producers with custom control plane (e.g. Cloud SQL) doesn't need to // populate this field. Instead they should use software_versions. SlmInstanceTemplate string `json:"slmInstanceTemplate,omitempty"` // SloMetadata: Output only. SLO metadata for instance classification in the // Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for // feature description. SloMetadata *GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata `json:"sloMetadata,omitempty"` // SoftwareVersions: Software versions that are used to deploy this instance. // This can be mutated by rollout services. SoftwareVersions map[string]string `json:"softwareVersions,omitempty"` // State: Output only. Current lifecycle state of the resource (e.g. if it's // being created or ready to use). // // Possible values: // "STATE_UNSPECIFIED" - Unspecified state. // "CREATING" - Instance is being created. // "READY" - Instance has been created and is ready to use. // "UPDATING" - Instance is being updated. // "REPAIRING" - Instance is unheathy and under repair. // "DELETING" - Instance is being deleted. // "ERROR" - Instance encountered an error and is in indeterministic state. State string `json:"state,omitempty"` // TenantProjectId: Output only. ID of the associated GCP tenant project. See // go/get-instance-metadata. TenantProjectId string `json:"tenantProjectId,omitempty"` // UpdateTime: Output only. Timestamp when the resource was last modified. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "ConsumerDefinedName") 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. "ConsumerDefinedName") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1Instance: Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/in stances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` LINT.IfChange
func (GoogleCloudSaasacceleratorManagementProvidersV1Instance) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1Instance) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule ¶
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule struct { // CanReschedule: This field is deprecated, and will be always set to true // since reschedule can happen multiple times now. This field should not be // removed until all service producers remove this for their customers. CanReschedule bool `json:"canReschedule,omitempty"` // EndTime: The scheduled end time for the maintenance. EndTime string `json:"endTime,omitempty"` // RolloutManagementPolicy: The rollout management policy this maintenance // schedule is associated with. When doing reschedule update request, the // reschedule should be against this given policy. RolloutManagementPolicy string `json:"rolloutManagementPolicy,omitempty"` // ScheduleDeadlineTime: schedule_deadline_time is the time deadline any // schedule start time cannot go beyond, including reschedule. It's normally // the initial schedule start time plus maintenance window length (1 day or 1 // week). Maintenance cannot be scheduled to start beyond this deadline. ScheduleDeadlineTime string `json:"scheduleDeadlineTime,omitempty"` // StartTime: The scheduled start time for the maintenance. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "CanReschedule") 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. "CanReschedule") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule: Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule
func (GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings ¶
type GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings struct { // Exclude: Optional. Exclude instance from maintenance. When true, rollout // service will not attempt maintenance on the instance. Rollout service will // include the instance in reported rollout progress as not attempted. Exclude bool `json:"exclude,omitempty"` // IsRollback: Optional. If the update call is triggered from rollback, set the // value as true. IsRollback bool `json:"isRollback,omitempty"` // MaintenancePolicies: Optional. The MaintenancePolicies that have been // attached to the instance. The key must be of the type name of the oneof // policy name defined in MaintenancePolicy, and the embedded policy must // define the same policy type. For details, please refer to go/mr-user-guide. // Should not be set if maintenance_policy_names is set. If only the name is // needed, then only populate MaintenancePolicy.name. MaintenancePolicies map[string]MaintenancePolicy `json:"maintenancePolicies,omitempty"` // ForceSendFields is a list of field names (e.g. "Exclude") 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. "Exclude") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings: Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.
func (GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata ¶
type GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata struct { // Location: The location of the node, if different from instance location. Location string `json:"location,omitempty"` // NodeId: The id of the node. This should be equal to // SaasInstanceNode.node_id. NodeId string `json:"nodeId,omitempty"` // PerSliEligibility: If present, this will override eligibility for the node // coming from instance or exclusions for specified SLIs. PerSliEligibility *GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility `json:"perSliEligibility,omitempty"` // ForceSendFields is a list of field names (e.g. "Location") 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. "Location") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata: Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.
func (GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter ¶ added in v0.75.0
type GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter struct { // Values: Optional. Array of string values. e.g. instance's replica // information. Values []string `json:"values,omitempty"` // ForceSendFields is a list of field names (e.g. "Values") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Values") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter: Contains notification related data.
func (GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter) MarshalJSON ¶ added in v0.75.0
func (s GoogleCloudSaasacceleratorManagementProvidersV1NotificationParameter) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility ¶ added in v0.44.0
type GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility struct { // Eligibilities: An entry in the eligibilities map specifies an eligibility // for a particular SLI for the given instance. The SLI key in the name must be // a valid SLI name specified in the Eligibility Exporter binary flags // otherwise an error will be emitted by Eligibility Exporter and the oncaller // will be alerted. If an SLI has been defined in the binary flags but the // eligibilities map does not contain it, the corresponding SLI time series // will not be emitted by the Eligibility Exporter. This ensures a smooth // rollout and compatibility between the data produced by different versions of // the Eligibility Exporters. If eligibilities map contains a key for an SLI // which has not been declared in the binary flags, there will be an error // message emitted in the Eligibility Exporter log and the metric for the SLI // in question will not be emitted. Eligibilities map[string]GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility `json:"eligibilities,omitempty"` // ForceSendFields is a list of field names (e.g. "Eligibilities") 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. "Eligibilities") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility: PerSliSloEligibility is a mapping from an SLI name to eligibility.
func (GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility) MarshalJSON ¶ added in v0.44.0
func (s GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource ¶
type GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource struct { // ResourceType: Type of the resource. This can be either a GCP resource or a // custom one (e.g. another cloud provider's VM). For GCP compute resources use // singular form of the names listed in GCP compute API documentation // (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with // 'compute-', for example: 'compute-instance', 'compute-disk', // 'compute-autoscaler'. ResourceType string `json:"resourceType,omitempty"` // ResourceUrl: URL identifying the resource, e.g. // "https://www.googleapis.com/compute/v1/projects/...)". ResourceUrl string `json:"resourceUrl,omitempty"` // ForceSendFields is a list of field names (e.g. "ResourceType") 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. "ResourceType") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource: Describes provisioned dataplane resources.
func (GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility ¶
type GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility struct { // Eligible: Whether an instance is eligible or ineligible. Eligible bool `json:"eligible,omitempty"` // Reason: User-defined reason for the current value of instance eligibility. // Usually, this can be directly mapped to the internal state. An empty reason // is allowed. Reason string `json:"reason,omitempty"` // ForceSendFields is a list of field names (e.g. "Eligible") 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. "Eligible") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility: SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.
func (GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility) MarshalJSON() ([]byte, error)
type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata ¶
type GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata struct { // Nodes: Optional. List of nodes. Some producers need to use per-node metadata // to calculate SLO. This field allows such producers to publish per-node SLO // meta data, which will be consumed by SSA Eligibility Exporter and published // in the form of per node metric to Monarch. Nodes []*GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata `json:"nodes,omitempty"` // PerSliEligibility: Optional. Multiple per-instance SLI eligibilities which // apply for individual SLIs. PerSliEligibility *GoogleCloudSaasacceleratorManagementProvidersV1PerSliSloEligibility `json:"perSliEligibility,omitempty"` // Tier: Name of the SLO tier the Instance belongs to. This name will be // expected to match the tiers specified in the service SLO configuration. // Field is mandatory and must not be empty. Tier string `json:"tier,omitempty"` // ForceSendFields is a list of field names (e.g. "Nodes") 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. "Nodes") 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:"-"` }
GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata: SloMetadata contains resources required for proper SLO classification of the instance.
func (GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata) MarshalJSON ¶
func (s GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata) MarshalJSON() ([]byte, error)
type Instance ¶
type Instance struct { // AuthorizedNetwork: The full name of the Google Compute Engine network // (/compute/docs/networks-and-firewalls#networks) to which the instance is // connected. If left unspecified, the `default` network will be used. AuthorizedNetwork string `json:"authorizedNetwork,omitempty"` // CreateTime: Output only. The time the instance was created. CreateTime string `json:"createTime,omitempty"` // DiscoveryEndpoint: Output only. Endpoint for the Discovery API. DiscoveryEndpoint string `json:"discoveryEndpoint,omitempty"` // DisplayName: User provided name for the instance, which is only used for // display purposes. Cannot be more than 80 characters. DisplayName string `json:"displayName,omitempty"` // InstanceMessages: List of messages that describe the current state of the // Memcached instance. InstanceMessages []*InstanceMessage `json:"instanceMessages,omitempty"` // Labels: Resource labels to represent user-provided metadata. Refer to cloud // documentation on labels for more details. // https://cloud.google.com/compute/docs/labeling-resources Labels map[string]string `json:"labels,omitempty"` // MaintenancePolicy: The maintenance policy for the instance. If not provided, // the maintenance event will be performed based on Memorystore internal // rollout schedule. MaintenancePolicy *GoogleCloudMemcacheV1MaintenancePolicy `json:"maintenancePolicy,omitempty"` // MaintenanceSchedule: Output only. Published maintenance schedule. MaintenanceSchedule *MaintenanceSchedule `json:"maintenanceSchedule,omitempty"` // MemcacheFullVersion: Output only. The full version of memcached server // running on this instance. System automatically determines the full memcached // version for an instance based on the input MemcacheVersion. The full version // format will be "memcached-1.5.16". MemcacheFullVersion string `json:"memcacheFullVersion,omitempty"` // MemcacheNodes: Output only. List of Memcached nodes. Refer to Node message // for more details. MemcacheNodes []*Node `json:"memcacheNodes,omitempty"` // MemcacheVersion: The major version of Memcached software. If not provided, // latest supported version will be used. Currently the latest supported major // version is `MEMCACHE_1_5`. The minor version will be automatically // determined by our system based on the latest supported minor version. // // Possible values: // "MEMCACHE_VERSION_UNSPECIFIED" - Memcache version is not specified by // customer // "MEMCACHE_1_5" - Memcached 1.5 version. // "MEMCACHE_1_6_15" - Memcached 1.6.15 version. MemcacheVersion string `json:"memcacheVersion,omitempty"` // Name: Required. Unique name of the resource in this scope including project // and location using the form: // `projects/{project_id}/locations/{location_id}/instances/{instance_id}` // Note: Memcached instances are managed and addressed at the regional level so // `location_id` here refers to a Google Cloud region; however, users may // choose which zones Memcached nodes should be provisioned in within an // instance. Refer to zones field for more details. Name string `json:"name,omitempty"` // NodeConfig: Required. Configuration for Memcached nodes. NodeConfig *NodeConfig `json:"nodeConfig,omitempty"` // NodeCount: Required. Number of nodes in the Memcached instance. NodeCount int64 `json:"nodeCount,omitempty"` // Parameters: User defined parameters to apply to the memcached process on // each node. Parameters *MemcacheParameters `json:"parameters,omitempty"` // ReservedIpRangeId: Optional. Contains the id of allocated IP address ranges // associated with the private service access connection for example, // "test-default" associated with IP range 10.0.0.0/29. ReservedIpRangeId []string `json:"reservedIpRangeId,omitempty"` // SatisfiesPzi: Optional. Output only. Reserved for future use. SatisfiesPzi bool `json:"satisfiesPzi,omitempty"` // SatisfiesPzs: Optional. Output only. Reserved for future use. SatisfiesPzs bool `json:"satisfiesPzs,omitempty"` // State: Output only. The state of this Memcached instance. // // Possible values: // "STATE_UNSPECIFIED" - State not set. // "CREATING" - Memcached instance is being created. // "READY" - Memcached instance has been created and ready to be used. // "UPDATING" - Memcached instance is updating configuration such as // maintenance policy and schedule. // "DELETING" - Memcached instance is being deleted. // "PERFORMING_MAINTENANCE" - Memcached instance is going through // maintenance, e.g. data plane rollout. // "MEMCACHE_VERSION_UPGRADING" - Memcached instance is undergoing memcached // engine version upgrade. State string `json:"state,omitempty"` // UpdateTime: Output only. The time the instance was updated. UpdateTime string `json:"updateTime,omitempty"` // Zones: Zones in which Memcached nodes should be provisioned. Memcached nodes // will be equally distributed across these zones. If not provided, the service // will by default create nodes in all zones in the region for the instance. Zones []string `json:"zones,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AuthorizedNetwork") 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. "AuthorizedNetwork") 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:"-"` }
Instance: A Memorystore for Memcached instance
func (Instance) MarshalJSON ¶
type InstanceMessage ¶
type InstanceMessage struct { // Code: A code that correspond to one type of user-facing message. // // Possible values: // "CODE_UNSPECIFIED" - Message Code not set. // "ZONE_DISTRIBUTION_UNBALANCED" - Memcached nodes are distributed unevenly. Code string `json:"code,omitempty"` // Message: Message on memcached instance which will be exposed to users. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") to include in API requests // with the JSON null value. By default, fields with empty values are omitted // from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` }
func (InstanceMessage) MarshalJSON ¶
func (s InstanceMessage) MarshalJSON() ([]byte, error)
type ListInstancesResponse ¶
type ListInstancesResponse struct { // Instances: A list of Memcached instances in the project in the specified // location, or across all locations. If the `location_id` in the parent field // of the request is "-", all regions available to the project are queried, and // the results aggregated. Instances []*Instance `json:"instances,omitempty"` // NextPageToken: Token to retrieve the next page of results, or empty if there // are no more results in the list. NextPageToken string `json:"nextPageToken,omitempty"` // Unreachable: 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. "Instances") 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. "Instances") 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:"-"` }
ListInstancesResponse: Response for ListInstances.
func (ListInstancesResponse) MarshalJSON ¶
func (s ListInstancesResponse) MarshalJSON() ([]byte, error)
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 ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in the // request. Operations []*Operation `json:"operations,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:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (ListOperationsResponse) MarshalJSON ¶
func (s ListOperationsResponse) 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 ¶
type LocationMetadata ¶
type LocationMetadata struct { // AvailableZones: Output only. The set of available zones in the location. The // map is keyed by the lowercase ID of each zone, as defined by GCE. These keys // can be specified in the `zones` field when creating a Memcached instance. AvailableZones map[string]ZoneMetadata `json:"availableZones,omitempty"` // ForceSendFields is a list of field names (e.g. "AvailableZones") 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. "AvailableZones") 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:"-"` }
LocationMetadata: Metadata for the given google.cloud.location.Location.
func (LocationMetadata) MarshalJSON ¶
func (s LocationMetadata) MarshalJSON() ([]byte, error)
type MaintenancePolicy ¶ added in v0.37.0
type MaintenancePolicy struct { // CreateTime: Output only. The time when the resource was created. CreateTime string `json:"createTime,omitempty"` // Description: Optional. Description of what this policy is for. Create/Update // methods return INVALID_ARGUMENT if the length is greater than 512. Description string `json:"description,omitempty"` // Labels: Optional. Resource labels to represent user provided metadata. Each // label is a key-value pair, where both the key and the value are arbitrary // strings provided by the user. Labels map[string]string `json:"labels,omitempty"` // Name: Required. MaintenancePolicy name using the form: // `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenan // ce_policy_id}` where {project_id} refers to a GCP consumer project ID, // {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be // 1-63 characters long and match the regular expression // `[a-z0-9]([-a-z0-9]*[a-z0-9])?`. Name string `json:"name,omitempty"` // State: Optional. The state of the policy. // // Possible values: // "STATE_UNSPECIFIED" - Unspecified state. // "READY" - Resource is ready to be used. // "DELETING" - Resource is being deleted. It can no longer be attached to // instances. State string `json:"state,omitempty"` // UpdatePolicy: Maintenance policy applicable to instance update. UpdatePolicy *UpdatePolicy `json:"updatePolicy,omitempty"` // UpdateTime: Output only. The time when the resource was updated. UpdateTime string `json:"updateTime,omitempty"` // 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:"-"` }
MaintenancePolicy: Defines policies to service maintenance events.
func (MaintenancePolicy) MarshalJSON ¶ added in v0.37.0
func (s MaintenancePolicy) MarshalJSON() ([]byte, error)
type MaintenanceSchedule ¶ added in v0.74.0
type MaintenanceSchedule struct { // EndTime: Output only. The end time of any upcoming scheduled maintenance for // this instance. EndTime string `json:"endTime,omitempty"` // ScheduleDeadlineTime: Output only. The deadline that the maintenance // schedule start time can not go beyond, including reschedule. ScheduleDeadlineTime string `json:"scheduleDeadlineTime,omitempty"` // StartTime: Output only. The start time of any upcoming scheduled maintenance // for this instance. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"` }
MaintenanceSchedule: Upcoming maintenance schedule.
func (MaintenanceSchedule) MarshalJSON ¶ added in v0.74.0
func (s MaintenanceSchedule) MarshalJSON() ([]byte, error)
type MaintenanceWindow ¶ added in v0.37.0
type MaintenanceWindow struct { // DailyCycle: Daily cycle. DailyCycle *DailyCycle `json:"dailyCycle,omitempty"` // WeeklyCycle: Weekly cycle. WeeklyCycle *WeeklyCycle `json:"weeklyCycle,omitempty"` // ForceSendFields is a list of field names (e.g. "DailyCycle") 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. "DailyCycle") 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:"-"` }
MaintenanceWindow: MaintenanceWindow definition.
func (MaintenanceWindow) MarshalJSON ¶ added in v0.37.0
func (s MaintenanceWindow) MarshalJSON() ([]byte, error)
type MemcacheParameters ¶
type MemcacheParameters struct { // Id: Output only. The unique ID associated with this set of parameters. Users // can use this id to determine if the parameters associated with the instance // differ from the parameters associated with the nodes. A discrepancy between // parameter ids can inform users that they may need to take action to apply // parameters on nodes. Id string `json:"id,omitempty"` // Params: User defined set of parameters to use in the memcached process. Params map[string]string `json:"params,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") 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. "Id") to include in API requests // with the JSON null value. By default, fields with empty values are omitted // from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` }
func (MemcacheParameters) MarshalJSON ¶
func (s MemcacheParameters) MarshalJSON() ([]byte, error)
type Node ¶
type Node struct { // Host: Output only. Hostname or IP address of the Memcached node used by the // clients to connect to the Memcached server on this node. Host string `json:"host,omitempty"` // MemcacheFullVersion: Output only. The full version of memcached server // running on this node. e.g. - memcached-1.5.16 MemcacheFullVersion string `json:"memcacheFullVersion,omitempty"` // MemcacheVersion: Output only. Major version of memcached server running on // this node, e.g. MEMCACHE_1_5 // // Possible values: // "MEMCACHE_VERSION_UNSPECIFIED" - Memcache version is not specified by // customer // "MEMCACHE_1_5" - Memcached 1.5 version. // "MEMCACHE_1_6_15" - Memcached 1.6.15 version. MemcacheVersion string `json:"memcacheVersion,omitempty"` // NodeId: Output only. Identifier of the Memcached node. The node id does not // include project or location like the Memcached instance name. NodeId string `json:"nodeId,omitempty"` // Parameters: User defined parameters currently applied to the node. Parameters *MemcacheParameters `json:"parameters,omitempty"` // Port: Output only. The port number of the Memcached server on this node. Port int64 `json:"port,omitempty"` // State: Output only. Current state of the Memcached node. // // Possible values: // "STATE_UNSPECIFIED" - Node state is not set. // "CREATING" - Node is being created. // "READY" - Node has been created and ready to be used. // "DELETING" - Node is being deleted. // "UPDATING" - Node is being updated. State string `json:"state,omitempty"` // Zone: Output only. Location (GCP Zone) for the Memcached node. Zone string `json:"zone,omitempty"` // ForceSendFields is a list of field names (e.g. "Host") 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. "Host") to include in API requests // with the JSON null value. By default, fields with empty values are omitted // from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` }
func (Node) MarshalJSON ¶
type NodeConfig ¶
type NodeConfig struct { // CpuCount: Required. Number of cpus per Memcached node. CpuCount int64 `json:"cpuCount,omitempty"` // MemorySizeMb: Required. Memory size in MiB for each Memcached node. MemorySizeMb int64 `json:"memorySizeMb,omitempty"` // ForceSendFields is a list of field names (e.g. "CpuCount") 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. "CpuCount") 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:"-"` }
NodeConfig: Configuration for a Memcached Node.
func (NodeConfig) MarshalJSON ¶
func (s NodeConfig) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in progress. // If `true`, the operation is completed, and either `error` or `response` is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. It // typically contains progress information and common metadata such as create // time. Some services might not provide such metadata. Any method that returns // a long-running operation should document the metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same service // that originally returns it. If you use the default HTTP mapping, the `name` // should be a resource name ending with `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal, successful response of the operation. If the original // method returns no data on success, such as `Delete`, the response is // `google.protobuf.Empty`. If the original method is standard // `Get`/`Create`/`Update`, the response should be the resource. For other // methods, the response should have the type `XxxResponse`, where `Xxx` is the // original method name. For example, if the original method name is // `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata struct { // ApiVersion: Output only. API version used to start the operation. ApiVersion string `json:"apiVersion,omitempty"` // CancelRequested: Output only. Identifies whether the user has requested // cancellation of the operation. Operations that have successfully been // cancelled have Operation.error value with a google.rpc.Status.code of 1, // corresponding to `Code.CANCELLED`. CancelRequested bool `json:"cancelRequested,omitempty"` // CreateTime: Output only. Time when the operation was created. CreateTime string `json:"createTime,omitempty"` // EndTime: Output only. Time when the operation finished running. EndTime string `json:"endTime,omitempty"` // StatusDetail: Output only. Human-readable status of the operation, if any. StatusDetail string `json:"statusDetail,omitempty"` // Target: Output only. Server-defined resource path for the target of the // operation. Target string `json:"target,omitempty"` // Verb: Output only. Name of the verb executed by the operation. Verb string `json:"verb,omitempty"` // ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"` }
OperationMetadata: Represents the metadata of a long-running operation.
func (OperationMetadata) MarshalJSON ¶
func (s OperationMetadata) MarshalJSON() ([]byte, error)
type ProjectsLocationsGetCall ¶
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsGetCall) Context ¶
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsGetCall) Do ¶
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
Do executes the "memcache.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 ¶
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
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 ProjectsLocationsInstancesApplyParametersCall ¶
type ProjectsLocationsInstancesApplyParametersCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesApplyParametersCall) Context ¶
func (c *ProjectsLocationsInstancesApplyParametersCall) Context(ctx context.Context) *ProjectsLocationsInstancesApplyParametersCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesApplyParametersCall) Do ¶
func (c *ProjectsLocationsInstancesApplyParametersCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.applyParameters" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesApplyParametersCall) Fields ¶
func (c *ProjectsLocationsInstancesApplyParametersCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesApplyParametersCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesApplyParametersCall) Header ¶
func (c *ProjectsLocationsInstancesApplyParametersCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesCreateCall ¶
type ProjectsLocationsInstancesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesCreateCall) Context ¶
func (c *ProjectsLocationsInstancesCreateCall) Context(ctx context.Context) *ProjectsLocationsInstancesCreateCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesCreateCall) Do ¶
func (c *ProjectsLocationsInstancesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesCreateCall) Fields ¶
func (c *ProjectsLocationsInstancesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesCreateCall) Header ¶
func (c *ProjectsLocationsInstancesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsInstancesCreateCall) InstanceId ¶
func (c *ProjectsLocationsInstancesCreateCall) InstanceId(instanceId string) *ProjectsLocationsInstancesCreateCall
InstanceId sets the optional parameter "instanceId": Required. The logical name of the Memcached instance in the user project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the user project / location. If any of the above are not met, the API raises an invalid argument error.
type ProjectsLocationsInstancesDeleteCall ¶
type ProjectsLocationsInstancesDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesDeleteCall) Context ¶
func (c *ProjectsLocationsInstancesDeleteCall) Context(ctx context.Context) *ProjectsLocationsInstancesDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesDeleteCall) Do ¶
func (c *ProjectsLocationsInstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesDeleteCall) Fields ¶
func (c *ProjectsLocationsInstancesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesDeleteCall) Header ¶
func (c *ProjectsLocationsInstancesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesGetCall ¶
type ProjectsLocationsInstancesGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesGetCall) Context ¶
func (c *ProjectsLocationsInstancesGetCall) Context(ctx context.Context) *ProjectsLocationsInstancesGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesGetCall) Do ¶
func (c *ProjectsLocationsInstancesGetCall) Do(opts ...googleapi.CallOption) (*Instance, error)
Do executes the "memcache.projects.locations.instances.get" call. Any non-2xx status code is an error. Response headers are in either *Instance.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 (*ProjectsLocationsInstancesGetCall) Fields ¶
func (c *ProjectsLocationsInstancesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesGetCall) Header ¶
func (c *ProjectsLocationsInstancesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsInstancesGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesGetCall
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 ProjectsLocationsInstancesListCall ¶
type ProjectsLocationsInstancesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesListCall) Context ¶
func (c *ProjectsLocationsInstancesListCall) Context(ctx context.Context) *ProjectsLocationsInstancesListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesListCall) Do ¶
func (c *ProjectsLocationsInstancesListCall) Do(opts ...googleapi.CallOption) (*ListInstancesResponse, error)
Do executes the "memcache.projects.locations.instances.list" call. Any non-2xx status code is an error. Response headers are in either *ListInstancesResponse.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 (*ProjectsLocationsInstancesListCall) Fields ¶
func (c *ProjectsLocationsInstancesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesListCall) Filter ¶
func (c *ProjectsLocationsInstancesListCall) Filter(filter string) *ProjectsLocationsInstancesListCall
Filter sets the optional parameter "filter": List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".
func (*ProjectsLocationsInstancesListCall) Header ¶
func (c *ProjectsLocationsInstancesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsInstancesListCall) IfNoneMatch ¶
func (c *ProjectsLocationsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsInstancesListCall
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 (*ProjectsLocationsInstancesListCall) OrderBy ¶
func (c *ProjectsLocationsInstancesListCall) OrderBy(orderBy string) *ProjectsLocationsInstancesListCall
OrderBy sets the optional parameter "orderBy": Sort results. Supported values are "name", "name desc" or "" (unsorted).
func (*ProjectsLocationsInstancesListCall) PageSize ¶
func (c *ProjectsLocationsInstancesListCall) PageSize(pageSize int64) *ProjectsLocationsInstancesListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the `page_size` value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried.
func (*ProjectsLocationsInstancesListCall) PageToken ¶
func (c *ProjectsLocationsInstancesListCall) PageToken(pageToken string) *ProjectsLocationsInstancesListCall
PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous List request, if any.
func (*ProjectsLocationsInstancesListCall) Pages ¶
func (c *ProjectsLocationsInstancesListCall) Pages(ctx context.Context, f func(*ListInstancesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsInstancesPatchCall ¶
type ProjectsLocationsInstancesPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesPatchCall) Context ¶
func (c *ProjectsLocationsInstancesPatchCall) Context(ctx context.Context) *ProjectsLocationsInstancesPatchCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesPatchCall) Do ¶
func (c *ProjectsLocationsInstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesPatchCall) Fields ¶
func (c *ProjectsLocationsInstancesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesPatchCall) Header ¶
func (c *ProjectsLocationsInstancesPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsInstancesPatchCall) UpdateMask ¶
func (c *ProjectsLocationsInstancesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsInstancesPatchCall
UpdateMask sets the optional parameter "updateMask": Required. Mask of fields to update. * `displayName`
type ProjectsLocationsInstancesRescheduleMaintenanceCall ¶ added in v0.78.0
type ProjectsLocationsInstancesRescheduleMaintenanceCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesRescheduleMaintenanceCall) Context ¶ added in v0.78.0
func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Context(ctx context.Context) *ProjectsLocationsInstancesRescheduleMaintenanceCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesRescheduleMaintenanceCall) Do ¶ added in v0.78.0
func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.rescheduleMaintenance" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesRescheduleMaintenanceCall) Fields ¶ added in v0.78.0
func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesRescheduleMaintenanceCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesRescheduleMaintenanceCall) Header ¶ added in v0.78.0
func (c *ProjectsLocationsInstancesRescheduleMaintenanceCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesService ¶
type ProjectsLocationsInstancesService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsInstancesService ¶
func NewProjectsLocationsInstancesService(s *Service) *ProjectsLocationsInstancesService
func (*ProjectsLocationsInstancesService) ApplyParameters ¶
func (r *ProjectsLocationsInstancesService) ApplyParameters(name string, applyparametersrequest *ApplyParametersRequest) *ProjectsLocationsInstancesApplyParametersCall
ApplyParameters: `ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.
- name: Resource name of the Memcached instance for which parameter group updates should be applied.
func (*ProjectsLocationsInstancesService) Create ¶
func (r *ProjectsLocationsInstancesService) Create(parent string, instance *Instance) *ProjectsLocationsInstancesCreateCall
Create: Creates a new Instance in a given location.
- parent: The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.
func (*ProjectsLocationsInstancesService) Delete ¶
func (r *ProjectsLocationsInstancesService) Delete(name string) *ProjectsLocationsInstancesDeleteCall
Delete: Deletes a single Instance.
- name: Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.
func (*ProjectsLocationsInstancesService) Get ¶
func (r *ProjectsLocationsInstancesService) Get(name string) *ProjectsLocationsInstancesGetCall
Get: Gets details of a single Instance.
- name: Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.
func (*ProjectsLocationsInstancesService) List ¶
func (r *ProjectsLocationsInstancesService) List(parent string) *ProjectsLocationsInstancesListCall
List: Lists Instances in a given location.
- parent: The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.
func (*ProjectsLocationsInstancesService) Patch ¶
func (r *ProjectsLocationsInstancesService) Patch(name string, instance *Instance) *ProjectsLocationsInstancesPatchCall
Patch: Updates an existing Instance in a given project and location.
- name: Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details.
func (*ProjectsLocationsInstancesService) RescheduleMaintenance ¶ added in v0.78.0
func (r *ProjectsLocationsInstancesService) RescheduleMaintenance(instance string, reschedulemaintenancerequest *RescheduleMaintenanceRequest) *ProjectsLocationsInstancesRescheduleMaintenanceCall
RescheduleMaintenance: Reschedules upcoming maintenance event.
- instance: Memcache instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.
func (*ProjectsLocationsInstancesService) UpdateParameters ¶
func (r *ProjectsLocationsInstancesService) UpdateParameters(name string, updateparametersrequest *UpdateParametersRequest) *ProjectsLocationsInstancesUpdateParametersCall
UpdateParameters: Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by `ApplyParameters` to apply the parameters to nodes of the Memcached instance.
- name: Resource name of the Memcached instance for which the parameters should be updated.
func (*ProjectsLocationsInstancesService) Upgrade ¶ added in v0.141.0
func (r *ProjectsLocationsInstancesService) Upgrade(name string, googlecloudmemcachev1upgradeinstancerequest *GoogleCloudMemcacheV1UpgradeInstanceRequest) *ProjectsLocationsInstancesUpgradeCall
Upgrade: Upgrades the Memcache instance to a newer memcached engine version specified in the request.
- name: Memcache instance resource name using the form: `projects/{project}/locations/{location}/instances/{instance}` where `location_id` refers to a GCP region.
type ProjectsLocationsInstancesUpdateParametersCall ¶
type ProjectsLocationsInstancesUpdateParametersCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesUpdateParametersCall) Context ¶
func (c *ProjectsLocationsInstancesUpdateParametersCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpdateParametersCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesUpdateParametersCall) Do ¶
func (c *ProjectsLocationsInstancesUpdateParametersCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.updateParameters" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesUpdateParametersCall) Fields ¶
func (c *ProjectsLocationsInstancesUpdateParametersCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpdateParametersCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesUpdateParametersCall) Header ¶
func (c *ProjectsLocationsInstancesUpdateParametersCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsInstancesUpgradeCall ¶ added in v0.141.0
type ProjectsLocationsInstancesUpgradeCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsInstancesUpgradeCall) Context ¶ added in v0.141.0
func (c *ProjectsLocationsInstancesUpgradeCall) Context(ctx context.Context) *ProjectsLocationsInstancesUpgradeCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsInstancesUpgradeCall) Do ¶ added in v0.141.0
func (c *ProjectsLocationsInstancesUpgradeCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.instances.upgrade" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsInstancesUpgradeCall) Fields ¶ added in v0.141.0
func (c *ProjectsLocationsInstancesUpgradeCall) Fields(s ...googleapi.Field) *ProjectsLocationsInstancesUpgradeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsInstancesUpgradeCall) Header ¶ added in v0.141.0
func (c *ProjectsLocationsInstancesUpgradeCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsListCall ¶
type ProjectsLocationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsListCall) Context ¶
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsListCall) Do ¶
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
Do executes the "memcache.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) Fields ¶
func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsListCall) Filter ¶
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
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 ¶
func (c *ProjectsLocationsListCall) Header() http.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 ¶
func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.
func (*ProjectsLocationsListCall) PageToken ¶
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
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 ¶
func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsCancelCall ¶
type ProjectsLocationsOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsCancelCall) Context ¶
func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsCancelCall) Do ¶
func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "memcache.projects.locations.operations.cancel" 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 (*ProjectsLocationsOperationsCancelCall) Fields ¶
func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsOperationsCancelCall) Header ¶
func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsOperationsDeleteCall ¶
type ProjectsLocationsOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsDeleteCall) Context ¶
func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsDeleteCall) Do ¶
func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "memcache.projects.locations.operations.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 (*ProjectsLocationsOperationsDeleteCall) Fields ¶
func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsOperationsDeleteCall) Header ¶
func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsOperationsGetCall ¶
type ProjectsLocationsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsGetCall) Context ¶
func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsGetCall) Do ¶
func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "memcache.projects.locations.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.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 (*ProjectsLocationsOperationsGetCall) Fields ¶
func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsOperationsGetCall) Header ¶
func (c *ProjectsLocationsOperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall
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 ProjectsLocationsOperationsListCall ¶
type ProjectsLocationsOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsOperationsListCall) Context ¶
func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall
Context sets the context to be used in this call's Do method.
func (*ProjectsLocationsOperationsListCall) Do ¶
func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "memcache.projects.locations.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.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 (*ProjectsLocationsOperationsListCall) Fields ¶
func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (*ProjectsLocationsOperationsListCall) Filter ¶
func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsOperationsListCall) Header ¶
func (c *ProjectsLocationsOperationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (*ProjectsLocationsOperationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall
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 (*ProjectsLocationsOperationsListCall) PageSize ¶
func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsOperationsListCall) PageToken ¶
func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsOperationsListCall) Pages ¶
func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type ProjectsLocationsOperationsService ¶
type ProjectsLocationsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsOperationsService ¶
func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService
func (*ProjectsLocationsOperationsService) Cancel ¶
func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
- name: The name of the operation resource to be cancelled.
func (*ProjectsLocationsOperationsService) Delete ¶
func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
- name: The name of the operation resource to be deleted.
func (*ProjectsLocationsOperationsService) Get ¶
func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- name: The name of the operation resource.
func (*ProjectsLocationsOperationsService) List ¶
func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
- name: The name of the operation's parent resource.
type ProjectsLocationsService ¶
type ProjectsLocationsService struct { Instances *ProjectsLocationsInstancesService Operations *ProjectsLocationsOperationsService // contains filtered or unexported fields }
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService) Get ¶
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
- name: Resource name for the location.
func (*ProjectsLocationsService) List ¶
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
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 RescheduleMaintenanceRequest ¶ added in v0.78.0
type RescheduleMaintenanceRequest struct { // RescheduleType: Required. If reschedule type is SPECIFIC_TIME, must set up // schedule_time as well. // // Possible values: // "RESCHEDULE_TYPE_UNSPECIFIED" - Not set. // "IMMEDIATE" - If the user wants to schedule the maintenance to happen now. // "NEXT_AVAILABLE_WINDOW" - If the user wants to use the existing // maintenance policy to find the next available window. // "SPECIFIC_TIME" - If the user wants to reschedule the maintenance to a // specific time. RescheduleType string `json:"rescheduleType,omitempty"` // ScheduleTime: Timestamp when the maintenance shall be rescheduled to if // reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example // `2012-11-15T16:19:00.094Z`. ScheduleTime string `json:"scheduleTime,omitempty"` // ForceSendFields is a list of field names (e.g. "RescheduleType") 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. "RescheduleType") 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:"-"` }
RescheduleMaintenanceRequest: Request for RescheduleMaintenance.
func (RescheduleMaintenanceRequest) MarshalJSON ¶ added in v0.78.0
func (s RescheduleMaintenanceRequest) MarshalJSON() ([]byte, error)
type Schedule ¶ added in v0.37.0
type Schedule struct { // Day: Allows to define schedule that runs specified day of the week. // // Possible values: // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. // "MONDAY" - Monday // "TUESDAY" - Tuesday // "WEDNESDAY" - Wednesday // "THURSDAY" - Thursday // "FRIDAY" - Friday // "SATURDAY" - Saturday // "SUNDAY" - Sunday Day string `json:"day,omitempty"` // Duration: Output only. Duration of the time window, set by service producer. Duration string `json:"duration,omitempty"` // StartTime: Time within the window to start the operations. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"` }
Schedule: Configure the schedule.
func (Schedule) MarshalJSON ¶ added in v0.37.0
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
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 ¶
NewService creates a new Service.
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a common // set of message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in English. Any // user-facing error message should be localized and sent in the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
func (Status) MarshalJSON ¶
type TimeOfDay ¶ added in v0.37.0
type TimeOfDay struct { // Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API may // choose to allow the value "24:00:00" for scenarios like business closing // time. Hours int64 `json:"hours,omitempty"` // Minutes: Minutes of hour of day. Must be from 0 to 59. Minutes int64 `json:"minutes,omitempty"` // Nanos: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. Nanos int64 `json:"nanos,omitempty"` // Seconds: Seconds of minutes of the time. Must normally be from 0 to 59. An // API may allow the value 60 if it allows leap-seconds. Seconds int64 `json:"seconds,omitempty"` // ForceSendFields is a list of field names (e.g. "Hours") 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. "Hours") 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:"-"` }
TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
func (TimeOfDay) MarshalJSON ¶ added in v0.37.0
type UpdateParametersRequest ¶
type UpdateParametersRequest struct { // Parameters: The parameters to apply to the instance. Parameters *MemcacheParameters `json:"parameters,omitempty"` // UpdateMask: Required. Mask of fields to update. UpdateMask string `json:"updateMask,omitempty"` // ForceSendFields is a list of field names (e.g. "Parameters") 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. "Parameters") 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:"-"` }
UpdateParametersRequest: Request for UpdateParameters.
func (UpdateParametersRequest) MarshalJSON ¶
func (s UpdateParametersRequest) MarshalJSON() ([]byte, error)
type UpdatePolicy ¶ added in v0.37.0
type UpdatePolicy struct { // Channel: Optional. Relative scheduling channel applied to resource. // // Possible values: // "UPDATE_CHANNEL_UNSPECIFIED" - Unspecified channel. // "EARLIER" - Early channel within a customer project. // "LATER" - Later channel within a customer project. // "WEEK1" - ! ! The follow channels can ONLY be used if you adopt the new MW // system! ! ! NOTE: all WEEK channels are assumed to be under a weekly window. // ! There is currently no dedicated channel definitions for Daily windows. ! // If you use Daily window, the system will assume a 1d (24Hours) advanced ! // notification period b/w EARLY and LATER. ! We may consider support more // flexible daily channel specifications in ! the future. WEEK1 == EARLIER with // minimum 7d advanced notification. {7d, 14d} The system will treat them // equally and will use WEEK1 whenever it can. New customers are encouraged to // use this channel annotation. // "WEEK2" - WEEK2 == LATER with minimum 14d advanced notification {14d, // 21d}. // "WEEK5" - WEEK5 == 40d support. minimum 35d advanced notification {35d, // 42d}. Channel string `json:"channel,omitempty"` // DenyMaintenancePeriods: Deny Maintenance Period that is applied to resource // to indicate when maintenance is forbidden. The protocol supports // zero-to-many such periods, but the current SLM Rollout implementation only // supports zero-to-one. DenyMaintenancePeriods []*DenyMaintenancePeriod `json:"denyMaintenancePeriods,omitempty"` // Window: Optional. Maintenance window that is applied to resources covered by // this policy. Window *MaintenanceWindow `json:"window,omitempty"` // ForceSendFields is a list of field names (e.g. "Channel") 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. "Channel") 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:"-"` }
UpdatePolicy: Maintenance policy applicable to instance updates.
func (UpdatePolicy) MarshalJSON ¶ added in v0.37.0
func (s UpdatePolicy) MarshalJSON() ([]byte, error)
type WeeklyCycle ¶ added in v0.37.0
type WeeklyCycle struct { // Schedule: User can specify multiple windows in a week. Minimum of 1 window. Schedule []*Schedule `json:"schedule,omitempty"` // ForceSendFields is a list of field names (e.g. "Schedule") 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. "Schedule") 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:"-"` }
WeeklyCycle: Time window specified for weekly operations.
func (WeeklyCycle) MarshalJSON ¶ added in v0.37.0
func (s WeeklyCycle) MarshalJSON() ([]byte, error)
type WeeklyMaintenanceWindow ¶ added in v0.74.0
type WeeklyMaintenanceWindow struct { // Day: Required. Allows to define schedule that runs specified day of the // week. // // Possible values: // "DAY_OF_WEEK_UNSPECIFIED" - The day of the week is unspecified. // "MONDAY" - Monday // "TUESDAY" - Tuesday // "WEDNESDAY" - Wednesday // "THURSDAY" - Thursday // "FRIDAY" - Friday // "SATURDAY" - Saturday // "SUNDAY" - Sunday Day string `json:"day,omitempty"` // Duration: Required. Duration of the time window. Duration string `json:"duration,omitempty"` // StartTime: Required. Start time of the window in UTC. StartTime *TimeOfDay `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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:"-"` }
WeeklyMaintenanceWindow: Time window specified for weekly operations.
func (WeeklyMaintenanceWindow) MarshalJSON ¶ added in v0.74.0
func (s WeeklyMaintenanceWindow) MarshalJSON() ([]byte, error)
type ZoneMetadata ¶
type ZoneMetadata struct { }