Package google.cloud.resourcesettings.v1alpha1

색인

• ResourceSettingsService(인터페이스)
• CreateSettingValueRequest(메시지)
• DeleteSettingValueRequest(메시지)
• GetSettingValueRequest(메시지)
• ListSettingsRequest(메시지)
• ListSettingsResponse(메시지)
• LookupEffectiveSettingValueRequest(메시지)
• SearchSettingValuesRequest(메시지)
• SearchSettingValuesResponse(메시지)
• Setting(메시지)
• Setting.DataType(열거형)
• SettingValue(메시지)
• UpdateSettingValueRequest(메시지)
• Value(메시지)
• Value.StringSet(메시지)

리소스 설정 서비스

리소스 계층 구조 전반의 리소스 설정 및 설정 값과 상호작용하기 위한 인터페이스입니다.

서비스는 사용자가 리소스의 작동 방식을 제어할 수 있도록 여러 설정을 표시할 수 있습니다. 특정 Cloud 리소스에 적용된 설정 값은 계층적으로 평가되어 해당 리소스의 모든 하위 요소에 상속됩니다.

모든 요청에 대해 IAM 검사가 실패하거나 parent 리소스가 Cloud 조직에 없는 경우 google.rpc.Code.PERMISSION_DENIED가 포함된 google.rpc.Status를 반환합니다. 요청의 형식이 잘못된 경우 모든 요청에서 google.rpc.Code.INVALID_ARGUMENT가 포함된 google.rpc.Status를 반환합니다.

참고: 모든 알파 단계 설정의 경우 알파가 아닌 클라우드 조직의 리소스에 설정이 존재하지 않습니다.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue) 설정 값을 만듭니다. 설정이 없으면 google.rpc.Code.NOT_FOUND가 포함된 google.rpc.Status를 반환합니다. 지정된 Cloud 리소스에 설정 값이 이미 있는 경우 google.rpc.Code.ALREADY_EXISTS가 포함된 google.rpc.Status를 반환합니다. 설정이 읽기 전용으로 신고되면 google.rpc.Code.FAILED_PRECONDITION가 있는 google.rpc.Status를 반환합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty) 설정 값을 삭제합니다. 설정 값이 존재하지 않으면 작업이 작동하지 않습니다. 설정 또는 설정 값이 존재하지 않는 경우 google.rpc.Code.NOT_FOUND가 포함된 google.rpc.Status를 반환합니다. 설정 값에 대한 이전 DeleteSetting 호출이 이미 성공 코드를 반환했다면 설정 값이 존재하지 않습니다. 설정이 읽기 전용으로 신고되면 google.rpc.Code.FAILED_PRECONDITION가 있는 google.rpc.Status를 반환합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

GetSettingValue
rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue) 설정 값을 가져옵니다. 설정 값이 없으면 google.rpc.Code.NOT_FOUND가 포함된 google.rpc.Status를 반환합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

목록 설정
rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse) Cloud 리소스 parent에서 사용 가능한 모든 설정을 나열합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

조회 조회 설정값

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue) Cloud 리소스 parent에 있는 설정의 유효 설정 값을 계산합니다. 유효한 설정 값은 Cloud 리소스의 계산된 설정 값이며 주어진 순서에 따라 다음 옵션 중 하나로 평가됩니다. 이전 옵션이 없는 경우 다음 옵션이 사용됩니다. 지정된 리소스의 설정 값 지정된 리소스의 가장 가까운 상위 항목의 설정 값 설정의 기본값 모든 설정 해제된 SettingValue로 정의된 빈 설정 값 설정이 없으면 google.rpc.Code.NOT_FOUND가 포함된 google.rpc.Status를 반환합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

SearchSettingValues
rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse) 리소스 parent에 있는 모든 설정 값을 검색합니다. 설정 값은 특정 설정의 값으로 제한되지 않습니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue) 설정 값을 업데이트합니다. 설정 또는 설정 값이 존재하지 않는 경우 google.rpc.Code.NOT_FOUND가 포함된 google.rpc.Status를 반환합니다. 설정이 읽기 전용으로 신고되면 google.rpc.Code.FAILED_PRECONDITION가 있는 google.rpc.Status를 반환합니다. 요청에 제공된 etag가 설정 값의 유지된 etag와 일치하지 않으면 google.rpc.Code.ABORTED가 포함된 google.rpc.Status를 반환합니다. 참고: 제공된 설정 값은 모든 필드를 완전히 덮어씁니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/cloud-platform 자세한 내용은 인증 개요를 참조하세요.

CreateSettingValueRequest 클래스의 생성자

CreateSettingValue에 대한 요청입니다.

필드
setting_value	SettingValue 만들 설정 값입니다. 필드 요구사항은 SettingValue를 참고하세요. 승인을 처리하려면 지정된 리소스 settingValue에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.create

DeleteSettingValueRequest

DeleteSettingValue에 대한 요청입니다.

필드
name	string 삭제할 설정 값의 이름입니다. 이름 지정 요구사항은 SettingValue를 참고하세요. 승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.delete
ignore_read_only	bool read_only 설정 값을 삭제할 수 있는 플래그입니다. 경고: 사용에 따른 책임은 사용자에게 있습니다. 읽기 전용 설정의 값을 삭제하면 되돌릴 수 없습니다 (즉, 다시 생성할 수 없음).

GetSettingValueRequest

GetSettingValue에 대한 요청입니다.

필드
name	string 가져올 설정 값의 이름입니다. 이름 지정 요구사항은 SettingValue를 참고하세요. 승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.get

ListSettingsRequest

ListSettings 요청입니다.

필드
parent	string 설정을 상위로 하는 Cloud 리소스입니다. 다음 형식 중 하나여야 합니다. projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id} 승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settings.list
page_size	int32 사용되지 않습니다. 반환될 페이지의 크기입니다.
page_token	string 사용되지 않습니다. 다음 페이지를 가져오는 데 사용되는 페이지 토큰입니다.

ListSettingsResponse

ListSettings의 응답입니다.

필드
settings[]	Setting 지정된 Cloud 리소스에서 사용할 수 있는 설정 목록입니다.
next_page_token	string 사용되지 않습니다. 다음 페이지를 가져오는 데 사용되는 페이지 토큰입니다.

조회 조회 설정값 요청

LookupEffectiveSettingValue에 대한 요청.

필드
parent	string 유효 값을 평가할 설정입니다. 이름 지정 요구사항은 Setting를 참고하세요. 승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.get

SearchSettingValuesRequest 클래스의 생성자

SearchSettingValues에 대한 요청입니다.

필드
parent	string 설정을 상위로 하는 Cloud 리소스입니다. 다음 형식 중 하나여야 합니다. projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id} 승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.list
page_size	int32 사용되지 않습니다. 반환될 페이지의 크기입니다.
page_token	string 사용되지 않습니다. 다음 페이지를 가져오는 데 사용되는 페이지 토큰입니다.

검색 설정값 응답

SearchSettingValues의 응답입니다.

필드
setting_values[]	SettingValue 지정된 Cloud 리소스에 있는 모든 설정 값입니다.
next_page_token	string 사용되지 않습니다. 다음 페이지를 가져오는 데 사용되는 페이지 토큰입니다.

설정

값 설정을 위한 스키마입니다. 특정 Cloud 리소스에서 설정은 하나의 설정 값까지 상위 요소로 지정될 수 있습니다.

필드
name	string 설정의 리소스 이름입니다. 다음 형식 중 하나여야 합니다. projects/{project_number}/settings/{setting_name} folders/{folder_id}/settings/{setting_name} organizations/{organization_id}/settings/{setting_name} 예: '/projects/123/settings/gcp-enableMyFeature'
display_name	string 사람이 읽을 수 있는 설정 이름입니다.
description	string 이 설정의 기능에 대한 자세한 설명입니다.
read_only	bool 이 설정의 값을 수정할 수 없음을 나타내는 플래그입니다 (업데이트와 이유는 특정 설정에 관한 문서 참고). 하지만 DeleteSettingValueRequest.ignore_read_only가 true로 설정된 경우 DeleteSettingValue를 사용하여 삭제될 수 있습니다. 이 플래그를 사용하면 설정 값을 다시 만들 수 없음을 확인하는 것입니다. 자세한 내용은 DeleteSettingValueRequest.ignore_read_only을 참고하세요.
data_type	DataType 이 설정의 데이터 유형입니다.
default_value	Value 설정 값이 명시적으로 설정되지 않은 경우 LookupEffectiveSettingValue에서 수신한 값입니다. 참고: 일부 설정에는 기본값이 없습니다.

DataType

이 설정의 값을 설정하기 위한 데이터 유형입니다. 사용 가능한 데이터 유형에 관한 자세한 내용은 Value를 참고하세요.

열거형
DATA_TYPE_UNSPECIFIED	지정되지 않은 데이터 유형입니다.
BOOLEAN	부울 설정
STRING	문자열 설정.
STRING_SET	문자열 집합 설정

설정값

설정의 인스턴스화입니다. 모든 설정 값은 해당하는 설정의 상위 요소입니다.

필드
name	string 설정 값의 리소스 이름입니다. 다음 형식 중 하나여야 합니다. projects/{project_number}/settings/{setting_name}/value folders/{folder_id}/settings/{setting_name}/value organizations/{organization_id}/settings/{setting_name}/value 예: '/projects/123/settings/gcp-enableMyFeature/value'
value	Value 설정 값입니다. Value의 데이터 유형은 항상 상위 설정에서 정의된 데이터 유형과 일치해야 합니다.
etag	string 낙관적 동시 실행에 사용되는 지문입니다. 자세한 내용은 UpdateSettingValue을 참고하세요.
read_only	bool 출력 전용. 이 설정 값을 수정할 수 없음을 나타내는 플래그입니다. 그러나 DeleteSettingValueRequest.ignore_read_only가 true로 설정된 경우 DeleteSettingValue를 사용하여 삭제할 수 있습니다. 이 플래그를 사용하면 설정 값을 다시 만들 수 없음을 확인하는 것입니다. 이 플래그는 상위 설정에서 상속되며 편의를 위해 사용됩니다. 자세한 내용은 Setting.read_only을 참고하세요.
update_time	Timestamp 출력 전용. 설정 값이 마지막으로 업데이트된 시간을 나타내는 타임스탬프입니다.

UpdateSettingValueRequest 클래스의 생성자

UpdateSettingValue에 대한 요청입니다.

필드
setting_value	SettingValue 업데이트할 설정 값입니다. 필드 요구사항은 SettingValue를 참고하세요. 승인을 처리하려면 지정된 리소스 settingValue에 대해 다음과 같은 IAM 권한이 필요합니다. resourcesettings.settingvalues.update

값

설정 값의 데이터입니다.

필드
통합 필드 value는 데이터 유형과 관련 값을 선택합니다. value은 다음 중 하나여야 합니다.
boolean_value	bool 이 값을 불리언 값으로 정의합니다.
string_value	string 이 값을 문자열 값으로 정의합니다.
string_set_value	StringSet 이 값을 StringSet로 정의합니다.

StringSet

문자열 집합을 보유할 수 있는 문자열 집합 값입니다. 각 문자열의 최대 길이는 60자(영문 기준)이며 문자열 집합에 최대 50개의 문자열을 포함할 수 있습니다.

필드
values[]	string 집합에 포함된 문자열