Documentation
¶
Overview ¶
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package alpha defines operations in the declarative SDK.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package pubsub contains handwritten support code for the PubSub service.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func DCLTopicSchema() *dcl.Schema
- type Client
- func (c *Client) ApplyTopic(ctx context.Context, rawDesired *Topic, opts ...dcl.ApplyOption) (*Topic, error)
- func (c *Client) DeleteAllTopic(ctx context.Context, project string, filter func(*Topic) bool) error
- func (c *Client) DeleteTopic(ctx context.Context, r *Topic) error
- func (c *Client) GetTopic(ctx context.Context, r *Topic) (*Topic, error)
- func (c *Client) ListTopic(ctx context.Context, project string) (*TopicList, error)
- func (c *Client) ListTopicWithMaxResults(ctx context.Context, project string, pageSize int32) (*TopicList, error)
- type Topic
- type TopicList
- type TopicMessageStoragePolicy
Constants ¶
const TopicMaxPage = -1
Variables ¶
var YAML_topic []byte
Functions ¶
func DCLTopicSchema ¶ added in v1.10.3
Types ¶
type Client ¶
The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.
func (*Client) ApplyTopic ¶
func (*Client) DeleteAllTopic ¶
func (c *Client) DeleteAllTopic(ctx context.Context, project string, filter func(*Topic) bool) error
DeleteAllTopic deletes all resources that the filter functions returns true on.
type Topic ¶
type Topic struct {
Name *string `json:"name"`
KmsKeyName *string `json:"kmsKeyName"`
Labels map[string]string `json:"labels"`
MessageStoragePolicy *TopicMessageStoragePolicy `json:"messageStoragePolicy"`
Project *string `json:"project"`
}
func (*Topic) Describe ¶
func (r *Topic) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
type TopicMessageStoragePolicy ¶
type TopicMessageStoragePolicy struct {
AllowedPersistenceRegions []string `json:"allowedPersistenceRegions"`
// contains filtered or unexported fields
}
var EmptyTopicMessageStoragePolicy *TopicMessageStoragePolicy = &TopicMessageStoragePolicy{empty: true}
This object is used to assert a desired state where this TopicMessageStoragePolicy is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*TopicMessageStoragePolicy) Empty ¶
func (r *TopicMessageStoragePolicy) Empty() bool
func (*TopicMessageStoragePolicy) HashCode ¶
func (r *TopicMessageStoragePolicy) HashCode() string
func (*TopicMessageStoragePolicy) String ¶
func (r *TopicMessageStoragePolicy) String() string
func (*TopicMessageStoragePolicy) UnmarshalJSON ¶
func (r *TopicMessageStoragePolicy) UnmarshalJSON(data []byte) error
Source Files