ja-JP
ja-JP

Service: Secrets (ntt.secrets.v1alpha - v1alpha)

Service Secrets

Index

Resources

Project

Project Resource

Fields
name
string

Name of Project

Operations

GetProject
rpc GetProject(GetProjectRequest) returns (Project)

GetProject

BatchGetProjects
rpc BatchGetProjects(BatchGetProjectsRequest) returns (BatchGetProjectsResponse)

BatchGetProjects

ListProjects
rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse)

ListProjects

WatchProject
rpc WatchProject(WatchProjectRequest) returns (WatchProjectResponse)

WatchProject

WatchProjects
rpc WatchProjects(WatchProjectsRequest) returns (WatchProjectsResponse)

WatchProjects

CreateProject
rpc CreateProject(CreateProjectRequest) returns (Project)

CreateProject

UpdateProject
rpc UpdateProject(UpdateProjectRequest) returns (Project)

UpdateProject

DeleteProject
rpc DeleteProject(DeleteProjectRequest) returns (Empty)

DeleteProject

EncryptData
rpc EncryptData(EncryptDataRequest) returns (EncryptDataResponse)

EncryptData

DecryptData
rpc DecryptData(DecryptDataRequest) returns (DecryptDataResponse)

DecryptData

Messages

GetProjectRequest

Request message for method [GetProject][ntt.secrets.v1alpha.GetProject]

Fields
name
string

Reference of ntt.secrets.v1alpha.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsRequest

Request message for method [BatchGetProjects][ntt.secrets.v1alpha.BatchGetProjects]

Fields
parent
string

Optional parent ntt.secrets.v1alpha.Project

names
repeated string

Names of Projects

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsResponse

BatchGetProjectsResponse

Fields
projects
repeated Project

found Projects

missing
repeated string

list of not found Projects

ListProjectsRequest

Request message for method [ListProjects][ntt.secrets.v1alpha.ListProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProjectsResponse.next_page_token][ntt.secrets.v1alpha.ListProjectsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProjectsResponse

Request message for method [ListProjects][ntt.secrets.v1alpha.ListProjects]

Fields
projects
repeated Project

The list of Projects

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.secrets.v1alpha.ListProjectsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.secrets.v1alpha.ListProjectsRequest.page_token]

WatchProjectRequest

Request message for method [WatchProject][ntt.secrets.v1alpha.WatchProject]

Fields
name
string

Reference to ntt.secrets.v1alpha.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProjectResponse

WatchProjectResponse

Fields
change
ProjectChange
WatchProjectsRequest

Request message for method [WatchProjects][ntt.secrets.v1alpha.WatchProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Project that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Project that don't affect any of masked fields won't be sent back.

WatchProjectsResponse

WatchProjectsResponse

Fields
project_changes
repeated ProjectChange

Changes of Projects

page_token_change
WatchProjectsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProjectsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProjectRequest

Request message for method [CreateProject][ntt.secrets.v1alpha.CreateProject]

Fields
project
Project

Project resource body

UpdateProjectRequest

Request message for method [UpdateProject][ntt.secrets.v1alpha.UpdateProject]

Fields
project
Project

Project resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProjectRequest

Request message for method [DeleteProject][ntt.secrets.v1alpha.DeleteProject]

Fields
name
string

Reference of ntt.secrets.v1alpha.Project

EncryptDataRequest

Request message for method [EncryptDataRequest][ntt.devices.EncryptDataRequest]

Fields
project_name
string
data
bytes
EncryptDataResponse

Response message for method [EncryptDataResponse][ntt.devices.EncryptDataResponse]

Fields
data
bytes
DecryptDataRequest

Request message for method [DecryptDataRequest][ntt.devices.DecryptDataRequest]

Fields
project_name
string
data
bytes
DecryptDataResponse

Response message for method [DecryptDataResponse][ntt.devices.DecryptDataResponse]

Fields
data
bytes

Secret

Secret Resource

Fields
name
string

Name of Secret

value
string

Operations

GetSecret
rpc GetSecret(GetSecretRequest) returns (Secret)

GetSecret

BatchGetSecrets
rpc BatchGetSecrets(BatchGetSecretsRequest) returns (BatchGetSecretsResponse)

BatchGetSecrets

ListSecrets
rpc ListSecrets(ListSecretsRequest) returns (ListSecretsResponse)

ListSecrets

WatchSecret
rpc WatchSecret(WatchSecretRequest) returns (WatchSecretResponse)

WatchSecret

WatchSecrets
rpc WatchSecrets(WatchSecretsRequest) returns (WatchSecretsResponse)

WatchSecrets

CreateSecret
rpc CreateSecret(CreateSecretRequest) returns (Secret)

CreateSecret

UpdateSecret
rpc UpdateSecret(UpdateSecretRequest) returns (Secret)

UpdateSecret

DeleteSecret
rpc DeleteSecret(DeleteSecretRequest) returns (Empty)

DeleteSecret

Messages

GetSecretRequest

Request message for method [GetSecret][ntt.secrets.v1alpha.GetSecret]

Fields
name
string

Reference of ntt.secrets.v1alpha.Secret

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSecretsRequest

Request message for method [BatchGetSecrets][ntt.secrets.v1alpha.BatchGetSecrets]

Fields
parent
string

Optional parent ntt.secrets.v1alpha.Secret

names
repeated string

Names of Secrets

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSecretsResponse

BatchGetSecretsResponse

Fields
secrets
repeated Secret

found Secrets

missing
repeated string

list of not found Secrets

ListSecretsRequest

Request message for method [ListSecrets][ntt.secrets.v1alpha.ListSecrets]

Fields
parent
string

Parent name of ntt.secrets.v1alpha.Secret

page_size
int32

Requested page size. Server may return fewer Secrets than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListSecretsResponse.next_page_token][ntt.secrets.v1alpha.ListSecretsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListSecretsResponse

Request message for method [ListSecrets][ntt.secrets.v1alpha.ListSecrets]

Fields
secrets
repeated Secret

The list of Secrets

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListSecretsRequest.page_token][ntt.secrets.v1alpha.ListSecretsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListSecretsRequest.page_token][ntt.secrets.v1alpha.ListSecretsRequest.page_token]

WatchSecretRequest

Request message for method [WatchSecret][ntt.secrets.v1alpha.WatchSecret]

Fields
name
string

Reference to ntt.secrets.v1alpha.Secret

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchSecretResponse

WatchSecretResponse

Fields
change
SecretChange
WatchSecretsRequest

Request message for method [WatchSecrets][ntt.secrets.v1alpha.WatchSecrets]

Fields
parent
string

Parent reference of ntt.secrets.v1alpha.Secret

page_size
int32

Requested page size. Server may return fewer Secrets than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Secret that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Secret that don't affect any of masked fields won't be sent back.

WatchSecretsResponse

WatchSecretsResponse

Fields
secret_changes
repeated SecretChange

Changes of Secrets

page_token_change
WatchSecretsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchSecretsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateSecretRequest

Request message for method [CreateSecret][ntt.secrets.v1alpha.CreateSecret]

Fields
parent
string

Parent reference of ntt.secrets.v1alpha.Secret

secret
Secret

Secret resource body

UpdateSecretRequest

Request message for method [UpdateSecret][ntt.secrets.v1alpha.UpdateSecret]

Fields
secret
Secret

Secret resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteSecretRequest

Request message for method [DeleteSecret][ntt.secrets.v1alpha.DeleteSecret]

Fields
name
string

Reference of ntt.secrets.v1alpha.Secret

Shared Resources

Operations
Messages
Config
Fields
common_config
.ntt.environment.server.ServerEnvironment
ProjectChange

ProjectChange is used by Watch notifications Responses to describe change of single Project One of Added, Modified, Removed

Fields
added
ProjectChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProjectChange.Modified

Modified is returned when watched document is modified

removed
ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

ProjectChange.Added

Project has been added to query view

Fields
project
Project
view_index
int32

Integer describing index of added Project in resulting query view.

ProjectChange.Modified

Project changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Project

project
Project

New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Project. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Project new index in resulting query view.

ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Project index.

SecretChange

SecretChange is used by Watch notifications Responses to describe change of single Secret One of Added, Modified, Removed

Fields
added
SecretChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
SecretChange.Modified

Modified is returned when watched document is modified

removed
SecretChange.Removed

Removed is returned when Secret is deleted or leaves Query view

SecretChange.Added

Secret has been added to query view

Fields
secret
Secret
view_index
int32

Integer describing index of added Secret in resulting query view.

SecretChange.Modified

Secret changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Secret

secret
Secret

New version of Secret or masked difference, depending on mask_changes instrumentation of issued [WatchSecretRequest] or [WatchSecretsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Secret. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Secret new index in resulting query view.

SecretChange.Removed

Removed is returned when Secret is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Secret index.