# frozen_string_literal: true # Copyright 2024 Google LLC # # 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 # # https://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. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! module Google module Cloud module SecretManager module V1beta2 # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#list_secrets SecretManagerService.ListSecrets}. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the project associated with the # {::Google::Cloud::SecretManager::V1beta2::Secret Secrets}, in the format # `projects/*` or `projects/*/locations/*` # @!attribute [rw] page_size # @return [::Integer] # Optional. The maximum number of results to be returned in a single page. If # set to 0, the server decides the number of results to return. If the # number is greater than 25000, it is capped at 25000. # @!attribute [rw] page_token # @return [::String] # Optional. Pagination token, returned earlier via # {::Google::Cloud::SecretManager::V1beta2::ListSecretsResponse#next_page_token ListSecretsResponse.next_page_token}. # @!attribute [rw] filter # @return [::String] # Optional. Filter string, adhering to the rules in # [List-operation # filtering](https://cloud.google.com/secret-manager/docs/filtering). List # only secrets matching the filter. If filter is empty, all secrets are # listed. class ListSecretsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#list_secrets SecretManagerService.ListSecrets}. # @!attribute [rw] secrets # @return [::Array<::Google::Cloud::SecretManager::V1beta2::Secret>] # The list of {::Google::Cloud::SecretManager::V1beta2::Secret Secrets} sorted in # reverse by create_time (newest first). # @!attribute [rw] next_page_token # @return [::String] # A token to retrieve the next page of results. Pass this value in # {::Google::Cloud::SecretManager::V1beta2::ListSecretsRequest#page_token ListSecretsRequest.page_token} # to retrieve the next page. # @!attribute [rw] total_size # @return [::Integer] # The total number of {::Google::Cloud::SecretManager::V1beta2::Secret Secrets} # but 0 when the # {::Google::Cloud::SecretManager::V1beta2::ListSecretsRequest#filter ListSecretsRequest.filter} # field is set. class ListSecretsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#create_secret SecretManagerService.CreateSecret}. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the project to associate with the # {::Google::Cloud::SecretManager::V1beta2::Secret Secret}, in the format # `projects/*` or `projects/*/locations/*`. # @!attribute [rw] secret_id # @return [::String] # Required. This must be unique within the project. # # A secret ID is a string with a maximum length of 255 characters and can # contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and # underscore (`_`) characters. # @!attribute [rw] secret # @return [::Google::Cloud::SecretManager::V1beta2::Secret] # Required. A {::Google::Cloud::SecretManager::V1beta2::Secret Secret} with # initial field values. class CreateSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#add_secret_version SecretManagerService.AddSecretVersion}. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::Secret Secret} to associate with the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} in the # format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. # @!attribute [rw] payload # @return [::Google::Cloud::SecretManager::V1beta2::SecretPayload] # Required. The secret payload of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. class AddSecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#get_secret SecretManagerService.GetSecret}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::Secret Secret}, in the format # `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. class GetSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#list_secret_versions SecretManagerService.ListSecretVersions}. # @!attribute [rw] parent # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::Secret Secret} associated with the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersions} to list, # in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. # @!attribute [rw] page_size # @return [::Integer] # Optional. The maximum number of results to be returned in a single page. If # set to 0, the server decides the number of results to return. If the # number is greater than 25000, it is capped at 25000. # @!attribute [rw] page_token # @return [::String] # Optional. Pagination token, returned earlier via # ListSecretVersionsResponse.next_page_token][]. # @!attribute [rw] filter # @return [::String] # Optional. Filter string, adhering to the rules in # [List-operation # filtering](https://cloud.google.com/secret-manager/docs/filtering). List # only secret versions matching the filter. If filter is empty, all secret # versions are listed. class ListSecretVersionsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#list_secret_versions SecretManagerService.ListSecretVersions}. # @!attribute [rw] versions # @return [::Array<::Google::Cloud::SecretManager::V1beta2::SecretVersion>] # The list of # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersions} sorted # in reverse by create_time (newest first). # @!attribute [rw] next_page_token # @return [::String] # A token to retrieve the next page of results. Pass this value in # {::Google::Cloud::SecretManager::V1beta2::ListSecretVersionsRequest#page_token ListSecretVersionsRequest.page_token} # to retrieve the next page. # @!attribute [rw] total_size # @return [::Integer] # The total number of # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersions} but 0 # when the # {::Google::Cloud::SecretManager::V1beta2::ListSecretsRequest#filter ListSecretsRequest.filter} # field is set. class ListSecretVersionsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#get_secret_version SecretManagerService.GetSecretVersion}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} in the # format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # # `projects/*/secrets/*/versions/latest` or # `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most # recently created # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. class GetSecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#update_secret SecretManagerService.UpdateSecret}. # @!attribute [rw] secret # @return [::Google::Cloud::SecretManager::V1beta2::Secret] # Required. {::Google::Cloud::SecretManager::V1beta2::Secret Secret} with updated # field values. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # Required. Specifies the fields to be updated. class UpdateSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#access_secret_version SecretManagerService.AccessSecretVersion}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} in the # format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # # `projects/*/secrets/*/versions/latest` or # `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most # recently created # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. class AccessSecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#access_secret_version SecretManagerService.AccessSecretVersion}. # @!attribute [rw] name # @return [::String] # The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} in the # format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # @!attribute [rw] payload # @return [::Google::Cloud::SecretManager::V1beta2::SecretPayload] # Secret payload class AccessSecretVersionResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#delete_secret SecretManagerService.DeleteSecret}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::Secret Secret} to delete in the format # `projects/*/secrets/*`. # @!attribute [rw] etag # @return [::String] # Optional. Etag of the {::Google::Cloud::SecretManager::V1beta2::Secret Secret}. # The request succeeds if it matches the etag of the currently stored secret # object. If the etag is omitted, the request succeeds. class DeleteSecretRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#disable_secret_version SecretManagerService.DisableSecretVersion}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} to # disable in the format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # @!attribute [rw] etag # @return [::String] # Optional. Etag of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. The # request succeeds if it matches the etag of the currently stored secret # version object. If the etag is omitted, the request succeeds. class DisableSecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#enable_secret_version SecretManagerService.EnableSecretVersion}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} to enable # in the format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # @!attribute [rw] etag # @return [::String] # Optional. Etag of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. The # request succeeds if it matches the etag of the currently stored secret # version object. If the etag is omitted, the request succeeds. class EnableSecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for # {::Google::Cloud::SecretManager::V1beta2::SecretManagerService::Client#destroy_secret_version SecretManagerService.DestroySecretVersion}. # @!attribute [rw] name # @return [::String] # Required. The resource name of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion} to # destroy in the format `projects/*/secrets/*/versions/*` or # `projects/*/locations/*/secrets/*/versions/*`. # @!attribute [rw] etag # @return [::String] # Optional. Etag of the # {::Google::Cloud::SecretManager::V1beta2::SecretVersion SecretVersion}. The # request succeeds if it matches the etag of the currently stored secret # version object. If the etag is omitted, the request succeeds. class DestroySecretVersionRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end