blob: f8573be0c07b08b1085cd47384e20e71518e57c3 [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/networkmanagement/apiv1",
"version": "1.10.0",
"language": "GO",
"apis": [
{
"id": "google.cloud.networkmanagement.v1",
"version": "v1"
}
]
},
"snippets": [
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_CancelOperation_sync",
"title": "networkmanagement CancelOperation Sample",
"description": "CancelOperation is a utility method from google.longrunning.Operations.",
"file": "ReachabilityClient/CancelOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CancelOperation",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.CancelOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.CancelOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "CancelOperation",
"fullName": "google.longrunning.Operations.CancelOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_CreateConnectivityTest_sync",
"title": "networkmanagement CreateConnectivityTest Sample",
"description": "CreateConnectivityTest creates a new Connectivity Test.\nAfter you create a test, the reachability analysis is performed as part\nof the long running operation, which completes when the analysis completes.\n\nIf the endpoint specifications in `ConnectivityTest` are invalid\n(for example, containing non-existent resources in the network, or you\ndon't have read permissions to the network configurations of listed\nprojects), then the reachability result returns a value of `UNKNOWN`.\n\nIf the endpoint specifications in `ConnectivityTest` are\nincomplete, the reachability result returns a value of\n<code>AMBIGUOUS</code>. For more information,\nsee the Connectivity Test documentation.",
"file": "ReachabilityClient/CreateConnectivityTest/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.CreateConnectivityTest",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.CreateConnectivityTestRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "CreateConnectivityTestOperation",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "CreateConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.CreateConnectivityTest",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_DeleteConnectivityTest_sync",
"title": "networkmanagement DeleteConnectivityTest Sample",
"description": "DeleteConnectivityTest deletes a specific `ConnectivityTest`.",
"file": "ReachabilityClient/DeleteConnectivityTest/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.DeleteConnectivityTest",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.DeleteConnectivityTestRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "DeleteConnectivityTestOperation",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "DeleteConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.DeleteConnectivityTest",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 56,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_DeleteOperation_sync",
"title": "networkmanagement DeleteOperation Sample",
"description": "DeleteOperation is a utility method from google.longrunning.Operations.",
"file": "ReachabilityClient/DeleteOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteOperation",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.DeleteOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.DeleteOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "DeleteOperation",
"fullName": "google.longrunning.Operations.DeleteOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 51,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_GetConnectivityTest_sync",
"title": "networkmanagement GetConnectivityTest Sample",
"description": "GetConnectivityTest gets the details of a specific Connectivity Test.",
"file": "ReachabilityClient/GetConnectivityTest/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.GetConnectivityTest",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.GetConnectivityTestRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*networkmanagementpb.ConnectivityTest",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "GetConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.GetConnectivityTest",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_GetIamPolicy_sync",
"title": "networkmanagement GetIamPolicy Sample",
"description": "GetIamPolicy gets the access control policy for a resource. Returns an empty policy\nif the resource exists and does not have a policy set.",
"file": "ReachabilityClient/GetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetIamPolicy",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.GetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.GetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*iampb.Policy",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "GetIamPolicy",
"fullName": "google.iam.v1.IAMPolicy.GetIamPolicy",
"service": {
"shortName": "IAMPolicy",
"fullName": "google.iam.v1.IAMPolicy"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_GetLocation_sync",
"title": "networkmanagement GetLocation Sample",
"description": "GetLocation gets information about a location.",
"file": "ReachabilityClient/GetLocation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetLocation",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.GetLocation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.GetLocationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*locationpb.Location",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "GetLocation",
"fullName": "google.cloud.location.Locations.GetLocation",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_GetOperation_sync",
"title": "networkmanagement GetOperation Sample",
"description": "GetOperation is a utility method from google.longrunning.Operations.",
"file": "ReachabilityClient/GetOperation/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetOperation",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.GetOperation",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.GetOperationRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*longrunningpb.Operation",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "GetOperation",
"fullName": "google.longrunning.Operations.GetOperation",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_ListConnectivityTests_sync",
"title": "networkmanagement ListConnectivityTests Sample",
"description": "ListConnectivityTests lists all Connectivity Tests owned by a project.",
"file": "ReachabilityClient/ListConnectivityTests/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListConnectivityTests",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.ListConnectivityTests",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.ListConnectivityTestsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "ConnectivityTestIterator",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "ListConnectivityTests",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.ListConnectivityTests",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_ListLocations_sync",
"title": "networkmanagement ListLocations Sample",
"description": "ListLocations lists information about the supported locations for this service.",
"file": "ReachabilityClient/ListLocations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListLocations",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.ListLocations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "locationpb.ListLocationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "LocationIterator",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "ListLocations",
"fullName": "google.cloud.location.Locations.ListLocations",
"service": {
"shortName": "Locations",
"fullName": "google.cloud.location.Locations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_ListOperations_sync",
"title": "networkmanagement ListOperations Sample",
"description": "ListOperations is a utility method from google.longrunning.Operations.",
"file": "ReachabilityClient/ListOperations/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListOperations",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.ListOperations",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "longrunningpb.ListOperationsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "OperationIterator",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "ListOperations",
"fullName": "google.longrunning.Operations.ListOperations",
"service": {
"shortName": "Operations",
"fullName": "google.longrunning.Operations"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 60,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_RerunConnectivityTest_sync",
"title": "networkmanagement RerunConnectivityTest Sample",
"description": "RerunConnectivityTest rerun an existing `ConnectivityTest`.\nAfter the user triggers the rerun, the reachability analysis is performed\nas part of the long running operation, which completes when the analysis\ncompletes.\n\nEven though the test configuration remains the same, the reachability\nresult may change due to underlying network configuration changes.\n\nIf the endpoint specifications in `ConnectivityTest` become invalid (for\nexample, specified resources are deleted in the network, or you lost\nread permissions to the network configurations of listed projects), then\nthe reachability result returns a value of `UNKNOWN`.",
"file": "ReachabilityClient/RerunConnectivityTest/main.go",
"language": "GO",
"clientMethod": {
"shortName": "RerunConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.RerunConnectivityTest",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.RerunConnectivityTestRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "RerunConnectivityTestOperation",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "RerunConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.RerunConnectivityTest",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_SetIamPolicy_sync",
"title": "networkmanagement SetIamPolicy Sample",
"description": "SetIamPolicy sets the access control policy on the specified resource. Replaces\nany existing policy.\n\nCan return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`\nerrors.",
"file": "ReachabilityClient/SetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SetIamPolicy",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.SetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.SetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*iampb.Policy",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "SetIamPolicy",
"fullName": "google.iam.v1.IAMPolicy.SetIamPolicy",
"service": {
"shortName": "IAMPolicy",
"fullName": "google.iam.v1.IAMPolicy"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_TestIamPermissions_sync",
"title": "networkmanagement TestIamPermissions Sample",
"description": "TestIamPermissions returns permissions that a caller has on the specified resource. If the\nresource does not exist, this will return an empty set of\npermissions, not a `NOT_FOUND` error.\n\nNote: This operation is designed to be used for building\npermission-aware UIs and command-line tools, not for authorization\nchecking. This operation may \"fail open\" without warning.",
"file": "ReachabilityClient/TestIamPermissions/main.go",
"language": "GO",
"clientMethod": {
"shortName": "TestIamPermissions",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.TestIamPermissions",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.TestIamPermissionsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "*iampb.TestIamPermissionsResponse",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "TestIamPermissions",
"fullName": "google.iam.v1.IAMPolicy.TestIamPermissions",
"service": {
"shortName": "IAMPolicy",
"fullName": "google.iam.v1.IAMPolicy"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 53,
"type": "FULL"
}
]
},
{
"regionTag": "networkmanagement_v1_generated_ReachabilityService_UpdateConnectivityTest_sync",
"title": "networkmanagement UpdateConnectivityTest Sample",
"description": "UpdateConnectivityTest updates the configuration of an existing `ConnectivityTest`.\nAfter you update a test, the reachability analysis is performed as part\nof the long running operation, which completes when the analysis completes.\nThe Reachability state in the test resource is updated with the new result.\n\nIf the endpoint specifications in `ConnectivityTest` are invalid\n(for example, they contain non-existent resources in the network, or the\nuser does not have read permissions to the network configurations of\nlisted projects), then the reachability result returns a value of\n<code>UNKNOWN</code>.\n\nIf the endpoint specifications in `ConnectivityTest` are incomplete, the\nreachability result returns a value of `AMBIGUOUS`. See the documentation\nin `ConnectivityTest` for for more details.",
"file": "ReachabilityClient/UpdateConnectivityTest/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient.UpdateConnectivityTest",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "networkmanagementpb.UpdateConnectivityTestRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "UpdateConnectivityTestOperation",
"client": {
"shortName": "ReachabilityClient",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityClient"
},
"method": {
"shortName": "UpdateConnectivityTest",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService.UpdateConnectivityTest",
"service": {
"shortName": "ReachabilityService",
"fullName": "google.cloud.networkmanagement.v1.ReachabilityService"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 58,
"type": "FULL"
}
]
}
]
}